Merge remote-tracking branch 'upstream/0.16.x' into central-develop

.coveralls.yml

@@ -0,0 +1,2 @@
+repo_token: YfchfjB9wbHxDS7MDadVe09f2StV0pds1
+service_name: circleci

.github/ISSUE_TEMPLATE.md

@@ -2,26 +2,20 @@
 
 *Briefly describe what this is about*
 
+## System information
 
-## Branch or installer method
-
-*Please specify if you are using the current `develop` branch or which installation source you were using when the issue occurred.*
-
- - Installer: Windows/OSX/Debian (?)
- - Version: 0.15.1 (?)
-
-or:
-
- - Branch: develop (?)
+*Please specify the KA Lite version you were using and your operating system!*
 
+ - Operating system: ?
+ - Version: 0.16.?
+ - Browser: ?
 
 ## Traceback or relevant snippet from server.log
 
 ```
 INSERT TRACEBACK, LOG MESSAGES ETC. HERE
 ```
 
-
 ## How to reproduce
 
 1. Steps
@@ -34,4 +28,4 @@ INSERT TRACEBACK, LOG MESSAGES ETC. HERE
 
 ## Real-life consequences (anything community should be aware, for instance how it affects your deployment)
 
-*If applicaple*
+*If applicable*

.github/PULL_REQUEST_TEMPLATE.md

@@ -18,10 +18,6 @@ If not all TODOs are marked, this PR is considered WIP (work in progress)
 
 List the issues solved or partly solved by the PR
 
-## Documentation
-
-*If the PR has documentation, link the file here (either .rst in your repo or if built on Read The Docs)*
-
 ## Screenshots (if appropriate)
 
 *They're nice. :)*

CONTRIBUTING.md

@@ -1,13 +1,14 @@
-Please include the following information when opening an issue:
-* The branch you found the issue on
-* The current date / the build that the issue affects
-* Expected behavior
-* Actual behavior
-* Steps to reproduce (be detailed!)
-
-If opening a PR, please observe the following guidelines
-* If you're fixing a bug, write a regression test (or have a really good reason for not writing one... and I mean **really** good!). Additionally, add in a "Fixes `issue number`" for PRs that address a certain issue (e.g. "Fixes #3390").
-* If your PR changes or adds to the User Interface, please include screenshots in either the description or the comments.
-* Give a brief summary of your changes in the PR description. Add in any other notes that are important for the reviewer to know.
-* Update the documentation if your changes affect it (don't just assume they don't)
-* Double check your own code for good style
+# Read before posting!
+
+Does your post belong on Github?  If you are reporting a bug or issue, or are contributing to the development of Kolibri, then it belongs here!  If you are seeking advice on technical and non-technical elements of deploying KA Lite and Kolibri in your community, you'll find relevant information at our [community forum](https://community.learningequality.org). 
+
+
+# Especially this...
+
+**Use the template in the description field, without this critical information, we cannot help you.**
+
+# PRs
+
+If opening a PR, please make note that the template is different, and we expect
+tests to accept contribution unless with good reason.
+

MANIFEST.in.dist

@@ -7,7 +7,7 @@ include README.rst
 include setup.cfg
 include requirements.txt
 
-recursive-include kalite *.html *.txt *.png *.js *.css *.gif *.less *.otf *.svg *.woff *.eot *.ttf *.zip *.json *.handlebars
+recursive-include kalite *.html *.txt *.png *.js *.css *.gif *.less *.otf *.svg *.woff *.eot *.ttf *.zip *.json *.handlebars *.woff2
 
 # Get the empty DBs -- make sure they are properly generated!
 recursive-exclude kalite/database *

Makefile

@@ -102,7 +102,7 @@ assets:
 release: dist man
 	ls -l dist
 	echo "uploading above to PyPi, using twine"
-	twine upload -s dist/*
+	twine upload -s --sign-with gpg2 dist/*
 
 dist: clean clean-dev-db docs assets
 	python setup.py sdist --formats=$(format)

README.rst

@@ -1,15 +1,15 @@
 KA Lite
 =======
 
-by `Foundation for Learning Equality <https://learningequality.org/>`__
+by `Learning Equality <https://learningequality.org/>`__
 
 |Build Status| |Coverage Status| |Docs|
 
 .. |Build Status| image:: https://circleci.com/gh/learningequality/ka-lite/tree/develop.svg?style=svg
    :target: https://circleci.com/gh/learningequality/ka-lite/tree/develop
 
-.. |Coverage Status| image:: https://coveralls.io/repos/learningequality/ka-lite/badge.svg
-   :target: https://coveralls.io/r/learningequality/ka-lite
+.. |Coverage Status| image:: http://codecov.io/github/learningequality/ka-lite/coverage.svg?branch=develop
+  :target: http://codecov.io/github/learningequality/kolibri?branch=develop
 
 .. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
    :target: http://ka-lite.readthedocs.org/
@@ -41,14 +41,21 @@ Primary use cases include:
    up with a central database (to download new content and upload
    analytics) when in an area with internet connectivity.
 
-We would love for you to get involved!
---------------------------------------
+Get involved!
+-------------
 
 -  Learn how you can contribute code on our `KA Lite GitHub Wiki <https://github.com/learningequality/ka-lite/wiki>`__
 -  Report bugs by `creating issues <https://github.com/learningequality/ka-lite/wiki/Report-Bugs-by-Creating-Issues>`__
 -  Read more about the project's motivation at `Introducing KA Lite, an offline version of Khan
    Academy <http://jamiealexandre.com/blog/2012/12/12/ka-lite-offline-khan-academy/>`__.
 
+Connect
+^^^^^^^
+
+- IRC: **#kalite** on Freenode
+- Twitter: `@ka_lite <http://twitter.com/ka_lite>`__
+- Mailing list: `dev@learningequality.org on Google Groups <https://groups.google.com/a/learningequality.org/forum/#!forum/dev>`__
+
 Contact Us
 ^^^^^^^^^^
 

circle.yml

@@ -19,16 +19,26 @@ dependencies:
 test:
   override:
     - make assets
+    - make docs
     - kalite start --traceback -v2
     - kalite status
     - kalite stop --traceback -v2
     - cd sc-*-linux && ./bin/sc -u $SAUCE_USERNAME -k $SAUCE_ACCESS_KEY --tunnel-identifier $CIRCLE_BUILD_NUM-$CIRCLE_NODE_INDEX --readyfile ~/sauce_is_ready > sc_output.txt 2>&1:
         background: true
     - while [ ! -e ~/sauce_is_ready ]; do sleep 1; done
-    - case $CIRCLE_NODE_INDEX in 0) make test-bdd ;; 1) make test-nobdd;; esac:
+    - case $CIRCLE_NODE_INDEX in 0) coverage run --source=kalite --omit="kalite/testing/*,*/tests/*,*/migrations/*" kalitectl.py manage test --bdd-only ;; 1) coverage run --source=kalite --omit="kalite/testing/*,*/tests/*,*/migrations/*" kalitectl.py manage test --no-bdd;; esac:
         parallel: true
     # TODO: replace below with "make lint" when we're pep8
     - npm install -g jshint
     - jshint kalite/*/static/js/*/
   post:
     - killall --wait sc  # wait for Sauce Connect to close the tunnel
+    - bash <(curl -s https://codecov.io/bash)
+
+notify:
+  webhooks:
+    - url: https://coveralls.io/webhook?repo_token=YWMKkAVqIigWxX8XerfykVab17vEKmdXO
+
+general:
+  artifacts:
+    - 'coverage'

data/version.yml

@@ -1,3 +1,98 @@
+0.16.9:
+  release_date: "2016/09/05"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+       - Learner is not notified of mastery level, exercises keep displaying #4875
+       - Activating simplified login results in blank login modal #5255
+    students: []
+    coaches: []
+    admins: []
+
+0.16.8:
+  release_date: "2016/08/05"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+       - Mac OSX installer version (based on pyrun) crashes #5211
+       - Confusing and harmless "error" message removed from first-runs #5236
+       - Tests now run several minutes faster and are more reliable #5242
+    students: []
+    coaches: []
+    admins: []
+
+0.16.7:
+  release_date: "2016/08/01"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+       - Restore learner stats: Correctly display login count and aggregate login durations (previously uncollected data!) #5157
+       - Mastery percentage wrongly displayed on learner stats page #5181
+       - Speed up content scanning for up to 10x speedup when scanning big video directories, meaning content scanning drops from hours to minutes #5201
+       - Lockdown fix for user logins #5202
+       - Initial "pragma" support for SQLite and setting ``CONTENT_DB_SQLITE_PRAGMAS``. Use this to improve performance, such as allocating more memory for caching. `Peewee docs<http://docs.peewee-orm.com/en/latest/peewee/database.html#pragma-statements>`__. #5225
+       - Put max-height CSS rule on navbar logo #5206
+       - Submit correct HTTP ``user-agent`` for learningequality.org stats #5226
+       - Broken legacy assessment item download fixed (affects mainly some Debian packages) #5214
+       - Fix automatic CI tests so they now run (development issue, not related to deployments) #5201
+       - Added automatic coverage reports (development issue, not related to deployments) #5230
+       - Running ``setup`` command as root will give a warning + prompt, because we don't advice running as root. #5032
+       - Docs updates. Tested and updated Apache/Nginx WSGI guide, updated PPA setup to work on Debian/Raspbian
+       - Content packs. Added ~1700 dubbed videos in Non-English versions of the content packs, populating content databases and thus adding language support for - Burmese, Indonesian, Kannada, Swahili, Tamil, Xhosa, Zulu. `content-pack-maker#28 <https://github.com/fle-internal/content-pack-maker/issues/28>`__. #5120
+    students: []
+    coaches: []
+    admins: []
+
+
+0.16.6:
+  release_date: "2016/06/14"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+      - Content packs updated, bulk of broken exercises fixed and all languages rebuilt (and should be re-downloaded), pay attention to a couple of known issues!
+      - Allow logins during LOCKDOWN #5117
+      - Remove RPI warning message about max number of concurrent downloads, there's no longer a limit on small platforms #4982
+      - Make ROOT_DATA_PATH consider the KALITE_DIR environment variable #5143
+      - Restore downloading on RPI w/ m2crypto. Unbundle requests and use requests.get instead of urllib.urlretrieve #5138
+      - Docs. Add warning message on KA Lite windows application docs #5137
+      - Treat socket.error as if no server is running #5135
+      - Docs. Connect to ka-lite on IRC #ka-lite (Freenode) - #5127
+      - Notify student when all exercises in a series are completed (level has been mastered) #4875
+      - Use current year in parts of footer #5112
+      - Handle socket.error. Fix some cases where KA Lite fails to start due to a previous unclean shutdown #5132
+    students: []
+    coaches: []
+    admins: []
+
+
+0.16.5:
+  release_date: "2016/05/02"
+  git_commit: "cfcedf2"
+  new_features: []
+  bugs_fixed:
+    all:
+      - Missing fonts for some icons and math symbols #5110
+    students: []
+    coaches: []
+    admins: []
+
+
+0.16.4:
+  release_date: "2016/04/29"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+      - Update Perseus JS modules resulting in many broken exercises ( #5105 #5036 #5099 )
+      - Fix broken unpacking of legacy assessment items zip ( #5108 )
+    students: []
+    coaches: []
+    admins: []
+
 0.16.3:
   release_date: "2016/04/25"
   git_commit: ""

docs/conf.py

@@ -15,6 +15,8 @@
 import sys
 import os
 
+from datetime import datetime
+
 # Will use pyvirtualdisplay if "true", but if unset or for any other value will not
 #os.environ['SPHINX_SS_USE_PVD'] = "true"
 
@@ -30,14 +32,15 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
+    'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
@@ -60,7 +63,7 @@
 
 # General information about the project.
 project = u'KA Lite'
-copyright = u'2015, FLE'
+copyright = u'%d, Learning Equality' % datetime.now().year
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -69,7 +72,7 @@
 # The short X.Y version.
 version = V.SHORTVERSION
 # The full version, including alpha/beta/rc tags.
-release = V.SHORTVERSION
+release = V.VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -110,8 +113,38 @@
 #keep_warnings = False
 
 
+# Markup to shorten external links
+# Now, you can use the alias name as a new role, e.g. :issue:`123`.
+#   - You can also use the usual “explicit title” syntax supported by other
+#     roles that generate links, i.e. :issue:`this issue <123>`. In this case,
+#     the prefix is not relevant.
+# sphinx.pocoo.org/ext/extlinks.html
+url_pantry_base = 'http://pantry.learningequality.org/downloads/ka-lite/{version:s}/'.format(version=str(version))
+
+url_redirect_download_base = "https://learningequality.org/r/"
+url_windows_installer = url_redirect_download_base + (
+    "windows-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+url_osx_installer = url_redirect_download_base + (
+    "osx-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+url_deb_installer = url_redirect_download_base + (
+    "deb-bundle-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+url_deb_pi_installer = url_redirect_download_base + (
+    "deb-pi-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+
+extlinks = {
+    'url-issue': ('https://github.com/learningequality/ka-lite/issues/%s', '#'),
+    'url-pantry': (url_pantry_base + '%s', None),
+    'url-windows-installer': (url_windows_installer + '%s', None),
+    'url-osx-installer': (url_osx_installer + '%s', None),
+    'url-deb-installer': (url_deb_installer + '%s', None),
+    'url-deb-pi-installer': (url_deb_pi_installer + '%s', None),
+}
+
 # -- Options for HTML output ----------------------------------------------
-import os
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
@@ -214,7 +247,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   ('index', 'KALite.tex', u'KA Lite Documentation',
-   u'FLE', 'manual'),
+   u'Learning Equality', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -244,7 +277,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'kalite', u'KA Lite Documentation',
-     [u'FLE'], 1)
+     [u'Learning Equality'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -258,7 +291,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'KALite', u'KA Lite Documentation',
-   u'FLE', 'KALite', 'One line description of project.',
+   u'Learning Equality', 'KALite', 'One line description of project.',
    'Miscellaneous'),
 ]
 
@@ -281,3 +314,12 @@
 # sphinx-intl options
 locale_dirs = ['locale/']
 gettext_compact = False
+
+
+rst_prolog = (
+    ".. |version_major| replace:: {version_major:s}\n"
+    ".. |version_minor| replace:: {version_minor:s}\n"
+).format(
+    version_major=V.MAJOR_VERSION,
+    version_minor=V.MINOR_VERSION,
+)