Merge remote-tracking branch 'origin/0.16.x' into HEAD

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,37 @@
+## Summary
+
+*Briefly describe what this is about*
+
+
+## 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 (?)
+
+
+## Traceback or relevant snippet from server.log
+
+```
+INSERT TRACEBACK, LOG MESSAGES ETC. HERE
+```
+
+
+## How to reproduce
+
+1. Steps
+1. To
+1. Reproduce
+
+## Screenshots
+
+*If applicable*
+
+## Real-life consequences (anything community should be aware, for instance how it affects your deployment)
+
+*If applicaple*

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+## Summary
+
+*Short description*
+
+## TODO
+
+If not all TODOs are marked, this PR is considered WIP (work in progress)
+
+- [ ] Have **tests** been written for the new code? 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!)
+- [ ] Has documentation been written/updated?
+- [ ] New dependencies (if any) added to requirements file
+
+## Reviewer guidance
+
+*If you PR has a significant size, give the reviewer some helpful remarks*
+
+## Issues addressed
+
+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. :)*

.gitignore

@@ -2,6 +2,9 @@
 # File created by Coverage
 .coverage
 
+# PyCharm
+.idea
+
 # Eclipse
 .project
 .pydevproject
@@ -30,6 +33,9 @@ static-updates
 # MAC stuff
 .DS_Store
 
+# oh-my-zsh
+.venv
+
 # SQLite files (should probably specify the path)
 *.db
 *.sqlite*
@@ -38,12 +44,20 @@ static-updates
 *.patch
 *.pid
 *.prof
+secretkey.txt
 
 # Python compiling
 *.pyc
 *.pyo
+
+# Backup files
 *~
+
+# Sublime editor
 *.sublime-*
+
+# Ignore all .zip files!? No comment?? Needs fixing, I guess it's to avoid
+# committing local assessment items.
 *.zip
 
 # Documentation
@@ -53,6 +67,16 @@ docs/images/*
 # oh-my-zsh convention for automatically
 # switching on a venv
 .venv
+venv/
+
+# Ignore built javascript files
+/kalite/*/static/js/*/bundles
+
+# Ignore changes to Perseus and Khan Exercises that do not come from intentional edits
+/kalite/distributed/static/js/distributed/perseus
+
+# Ignore file used to store queued video download info.
+videos_to_download.json
 
 # Lacks documentation
 locale/

.jshintignore

@@ -0,0 +1,8 @@
+**/*.handlebars
+**/*.less
+**/*.css
+kalite/distributed/static/js/distributed/base/backbone-tastypie.js
+kalite/distributed/static/js/distributed/perseus/**/*
+kalite/*/static/js/*/bundles/*
+static-libraries/**
+kalite/i18n/static/js/i18n

.jshintrc

@@ -0,0 +1,5 @@
+{
+	"sub": true,
+	"browserify": true,
+	"browser": true
+}

MANIFEST.in.dist

@@ -3,22 +3,35 @@
 
 include kalitectl.py
 include LICENSE
-include README.md
+include README.rst
 include setup.cfg
 include requirements.txt
 
-recursive-include kalite *.html *.txt *.png *.js *.css *.gif *.less *.mo *.po *.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
 
-recursive-exclude kalite/static *
+# Get the empty DBs -- make sure they are properly generated!
+recursive-exclude kalite/database *
+recursive-include kalite/database/templates *sqlite
+recursive-include kalite/database/templates/content_items *sqlite
 
-exclude kalite/local_settings.py
-exclude kalite/settings/local_settings.py
-exclude kalite/private_key.pem
-exclude kalite/secrets.py
+# This can be a huge problem when creating an sdist from
+# a local development environment
+recursive-exclude kalite/static *
 
 # Data files, these are not picked up by sdist unless listed here
 recursive-include python-packages *
 recursive-include static-libraries *
+
+# There are still a couple of files left here, however main part is for build
+# process
 recursive-include data *
+recursive-exclude data/khan *
 
+# Necessary because it's a data directory so they
+# do not get automatically excluded
 recursive-exclude python-packages *pyc
+
+# Docs
+recursive-include docs/_build/html *
+include docs/kalite.1.gz
+

Makefile

@@ -0,0 +1,113 @@
+.PHONY: clean-pyc clean-build docs clean
+
+help:
+	@echo "clean - remove all build, test, coverage and Python artifacts"
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "clean-test - remove test and coverage artifacts"
+	@echo "lint - check style with pep8"
+	@echo "test - run tests the default Python"
+	@echo "test-bdd - run BDD tests only"
+	@echo "test-nobdd - run non-BDD tests only"
+	@echo "assets - build all JS/CSS assets"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release, options: format=[gztar,zip]"
+	@echo "dist - package locally, options: format=[gztar,zip]"
+	@echo "install - install the package to the active Python's site-packages"
+
+# used for release and dist targets
+format?=gztar
+
+clean: clean-build clean-pyc clean-test
+
+clean-dev-db:
+	rm -f kalite/database/data.sqlite
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	rm -fr dist-packages/
+	rm -fr dist-packages-temp/
+	rm -fr kalite/database/templates
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test:
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+
+lint:
+	pep8 kalite
+	jshint kalite/*/static/js/*/
+
+test:
+	bin/kalite manage test --bdd-only
+
+test-bdd: docs
+	bin/kalite manage test --bdd-only
+
+test-nobdd:
+	bin/kalite manage test --no-bdd
+
+test-all:
+	@echo "Not supported yet"
+	# tox
+
+coverage:
+	coverage run --source kalite kalitectl.py test
+	coverage report -m
+
+coverage-bdd:
+	coverage run --source kalite kalitectl.py test --bdd-only
+	coverage report -m
+
+coverage-nobdd:
+	coverage run --source kalite kalitectl.py test --no-bdd
+	coverage report -m
+
+docs:
+	# rm -f docs/ka-lite.rst
+	# rm -f docs/modules.rst
+	# sphinx-apidoc -o docs/ ka-lite-gtk
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	# open docs/_build/html/index.html
+
+
+# Runs separately from the docs command for now because of Windows issues
+man:
+	cli2man bin/kalite -o docs/kalite.1.gz
+
+assets:
+	# Necessary because NPM may have wrong versions in the cache
+	npm cache clean
+	npm install --production
+	node build.js
+	bin/kalite manage compileymltojson
+	bin/kalite manage syncdb --noinput
+	bin/kalite manage migrate
+	mkdir -p kalite/database/templates/
+	cp kalite/database/data.sqlite kalite/database/templates/
+	bin/kalite manage retrievecontentpack download en --minimal --foreground --template
+
+release: dist man
+	ls -l dist
+	echo "uploading above to PyPi, using twine"
+	twine upload -s dist/*
+
+dist: clean clean-dev-db docs assets
+	python setup.py sdist --formats=$(format)
+	python setup.py sdist --formats=$(format) --static
+	ls -l dist
+
+install: clean
+	python setup.py install