From 24317eccfb41b90ea301af4dea284d42101d374b Mon Sep 17 00:00:00 2001 From: alexander Date: Thu, 2 Feb 2017 23:28:21 +0200 Subject: [PATCH 1/4] Add markdownlint to .codeclimate.yml and codeclimate token to .travis.yml --- .codeclimate.yml | 3 +++ .travis.yml | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/.codeclimate.yml b/.codeclimate.yml index 128a8068..b22be273 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -15,11 +15,14 @@ engines: channel: "eslint-3" fixme: enabled: true + markdownlint: + enabled: true radon: enabled: true ratings: paths: - "**.css" - "**.js" + - "**.md" - "**.py" exclude_paths: [] diff --git a/.travis.yml b/.travis.yml index b0fdc877..5c1e162b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,3 +26,7 @@ script: after_success: - coveralls + +addons: + code_climate: + repo_token: 8b6b72db7cca0082ac23c0d86062b40eb3761d65bdfaafa85c491a2e0b95f8bd From 88e496a42438f4957fb5005060774259ce3c101e Mon Sep 17 00:00:00 2001 From: alexander Date: Thu, 2 Feb 2017 23:45:30 +0200 Subject: [PATCH 2/4] Update README to fix markdownlint complains and remove outdated info --- README.md | 40 ++++++++++++++++------------------------ 1 file changed, 16 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index a4ec51d8..d7fa0b65 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,25 @@ [![Coverage Status](https://coveralls.io/repos/github/raccoongang/xblock-video/badge.svg?branch=dev)](https://coveralls.io/github/raccoongang/xblock-video?branch=dev) # xblock-video + XBlock to embed videos hosted on different video platform into your courses. ## Installation -```bash -sudo -sHu edxapp -source ~/edxapp_env -# Clone and install xblock -git clone https://github.com/raccoongang/xblock-video.git -cd xblock-video -pip install -e . -# Install external JavaScript dependencies -cd video_xblock/static -bower install +```shell +> sudo -sHu edxapp +> source ~/edxapp_env +> # Clone and install xblock +> git clone https://github.com/raccoongang/xblock-video.git +> cd xblock-video +> pip install -e . +> # Install external JavaScript dependencies +> cd video_xblock/static +> bower install ``` ## Enabling in Studio + You can enable the Wistia xblock in studio through the advanced settings: @@ -37,6 +39,7 @@ TODO ## Development Install dependencies and development tools: + ```shell > pip install -r requirements.txt > pip install -r test_requirements.txt @@ -44,6 +47,7 @@ Install dependencies and development tools: ``` Run quality checks: + ```shell > make quality ``` @@ -54,19 +58,7 @@ Run tests: ## License -The code in this repository is licensed under the GPL v3 licence unless otherwise noted. +The code in this repository is licensed under the GPL v3 licence unless +otherwise noted. Please see `LICENSE` file for details. - - -## Tests - -Assuming revealjs is installed as above, you can run python tests like so: - -```nosetests video_xblock``` - -To get statement coverage: - -```nosetests video_xblock --with-coverage --coverage-package=video_xblock``` - - From ca50ae95f05204f6b4ba1a7a523536d50ecd0e40 Mon Sep 17 00:00:00 2001 From: alexander Date: Mon, 6 Feb 2017 16:26:55 +0200 Subject: [PATCH 3/4] Fix minor code style issue in README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3d57f33b..282731a8 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ Run quality checks: ``` Run tests: + ```shell > make test ``` From 65e5d8341d90f3e7f76a9da66c60dad22a191fe7 Mon Sep 17 00:00:00 2001 From: alexander Date: Thu, 9 Feb 2017 14:15:37 +0200 Subject: [PATCH 4/4] Remove unused codeclimate repo token from .travis.yml --- .travis.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 9cd2cfea..b9c021a5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -31,7 +31,3 @@ script: after_success: - coveralls - -addons: - code_climate: - repo_token: 8b6b72db7cca0082ac23c0d86062b40eb3761d65bdfaafa85c491a2e0b95f8bd