learningequality · benjaoming · May 5, 2017 · Feb 14, 2017 · Mar 17, 2017 · Mar 18, 2017
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,26 @@
+[paths]
+source = 
+    kalite/
+[run]
+source =
+    kalite/
+omit =
+    kalite/*/features/steps/*
+    kalite/testing/*
+    kalite/*/tests/*
+    kalite/*/migrations/*
+    kalite/packages/*
+    kalite/__main__.py
+    kalite/store/*
+    kalite/project/settings/*
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    if self.debug:
+    if settings.DEBUG
+    raise AssertionError
+    raise NotImplementedError
+    if 0:
+    if __name__ == .__main__.:
+
diff --git a/.coveralls.yml b/.coveralls.yml
diff --git a/Makefile b/Makefile
@@ -26,10 +26,10 @@ clean-build:
 	rm -fr dist/
 	rm -rf .kalite_dist_tmp
 	rm -fr .eggs/
-	rm -fr dist-packages/
-	rm -fr dist-packages-temp/
+	rm -fr .pip-temp/
 	rm -fr kalite/database/templates
 	rm -fr kalite/static-libraries/docs
+	find kalite/packages/dist/* -maxdepth 0 -type d -exec rm -fr {} +
 	find . -name '*.egg-info' -exec rm -fr {} +
 	find . -name '*.egg' -exec rm -f {} +
 
@@ -104,12 +104,16 @@ sdist: clean docs assets
 	# so we should delete those...
 	make clean-pyc
 	python setup.py sdist --formats=$(format) --static
+	python setup.py sdist --formats=$(format)
 
 dist: clean docs assets
-	# python setup.py sdist --formats=$(format)
+	# Building assets currently creates pyc files in the source dirs,
+	# so we should delete those...
+	make clean-pyc
+	python setup.py sdist --formats=$(format)
 	python setup.py bdist_wheel
-	# python setup.py sdist --formats=$(format) --static
-	python setup.py bdist_wheel --static  # --no-clean
+	python setup.py sdist --formats=$(format) --static
+	python setup.py bdist_wheel --static  --no-clean
 	ls -l dist
 
 install: clean

diff --git a/PACKAGING.md b/PACKAGING.md
diff --git a/README.rst b/README.rst
@@ -76,6 +76,7 @@ future of KA Lite.
 Connect
 ^^^^^^^
 
+- Community forums: `community.learningequality.org <https://community.learningequality.org/>`__
 - IRC: **#kalite** on Freenode
 - Twitter: `@ka_lite <http://twitter.com/ka_lite>`__
 - Mailing list: `[email protected] on Google Groups <https://groups.google.com/a/learningequality.org/forum/#!forum/dev>`__

diff --git a/circle.yml b/circle.yml
@@ -17,24 +17,17 @@ test:
     - sudo mv geckodriver /home/ubuntu/bin
     - export PATH="$PATH:/home/ubuntu/bin"
   override:
-    - make assets
+    - make assets:
+        parallel: true
     - make docs
     - kalite start --traceback -v2
     - sleep 6s  # Necessary for server to be ready
     - kalite status
     - kalite stop --traceback -v2
-    - case $CIRCLE_NODE_INDEX in 0) coverage run --source=kalite --omit="kalite/testing/*,*/tests/*,*/migrations/*,kalite/packages/*" bin/kalite manage test --bdd-only ;; 1) coverage run --source=kalite --omit="kalite/testing/*,kalite/packages/*,*/tests/*,*/migrations/*" bin/kalite manage test --no-bdd;; esac:
+    - case $CIRCLE_NODE_INDEX in 0) coverage run bin/kalite manage test --bdd-only ;; 1) coverage run bin/kalite 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:
-    - bash <(curl -s https://codecov.io/bash)
-
-notify:
-  webhooks:
-    - url: https://coveralls.io/webhook?repo_token=YWMKkAVqIigWxX8XerfykVab17vEKmdXO
-
-general:
-  artifacts:
-    - 'coverage'
+    - bash <(curl -s https://codecov.io/bash):
+        parallel: true
diff --git a/docs/conf.py b/docs/conf.py
@@ -63,7 +63,7 @@
 
 # General information about the project.
 project = u'KA Lite'
-copyright = u'%d, Learning Equality' % datetime.now().year
+copyright = u'%d, Learning Equality, licensed under a Creative Commons Attribution-ShareAlike 4.0 International License' % 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

diff --git a/docs/developer_docs/logging.rst b/docs/developer_docs/logging.rst
@@ -1,8 +1,16 @@
 Logging
 =======
 
+KA Lite application logs are stored in ``~/.kalite/logs/``. When going to daemon
+mode using ``kalite start``, all outputs are additionally stored in
+``~/.kalite/server.log``, which may contain more crash information for the last
+running instance.
+
+In Python, please always log to ``logging.getLogger(__name__)``! Fore more
+information on how logging is setup, refer to ``kalite.settings.base.LOGGING``.
+
 If you wish to view output from the server, you have a few options:
 
 *  Start the server with ``kalite start --foreground``. This will start the server using CherryPy and a single thread, with output going to your terminal.
 *  Start the server in development mode ``kalite manage runserver --settings=kalite.project.settings.dev`` (this doesn't start the job scheduler).
-*  Run the normal mode ``kalite start``, and check ``~/.kalite/server.log`` for output.
+
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -1,6 +1,18 @@
 Frequently Asked Questions
 ==========================
 
+Something isn't working - does KA Lite have log files?
+------------------------------------------------------
+
+It's very important to get more technical information if KA Lite is not working
+or crashing.
+
+Have a look at ``~/.kalite/logs`` (on Windows, locate something like
+``C:\Documents and Settings\<username>\.kalite``), where you will find the log
+files which KA Lite writes to while it's running. If KA Lite has crashed, have
+look at the latest log file. You can also refer to ``~/.kalite/server.log``
+which may in some cases contain more information regarding a crash.
+
 How do I install KA Lite?
 -------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,10 @@
    contain the root `toctree` directive.
 
 KA Lite Documentation
-===================================
+=====================
+
+by `Learning Equality <https://learningequality.org/>`__
+
 
 Welcome to the KA Lite Documentation page! Here, you will find all the 
 information needed to set up the KA Lite software. Additionally, there's 
@@ -15,13 +18,67 @@ check our `Forums`_!
 
 .. _Forums: https://community.learningequality.org/
 
+Main sections
+-------------
+
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
     Installation Guide <installguide/install_main>
     User Manual <usermanual/userman_main>
     FAQ <faq>
     Developer Docs <developer_docs/index>
 
 
-.. include:: ../README.rst
+About KA Lite
+-------------
+
+`Khan Academy <http://www.khanacademy.org/>`__'s core mission is to
+"provide a free world-class education for anyone anywhere", and as over `60%
+of the world's population is without access to the
+internet <http://en.wikipedia.org/wiki/Global_Internet_usage>`__,
+primarily in the developing world, providing an alternative delivery
+mechanism for Khan Academy content is key to fulfilling this mission.
+
+`KA Lite <http://kalite.learningequality.org/>`__ is a lightweight
+`Django <https://www.djangoproject.com/>`__ web app for serving core
+Khan Academy content (videos and exercises) from a local server, with
+points and progress-tracking, without needing internet connectivity.
+
+
+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
+^^^^^^^
+
+- Community forums: `community.learningequality.org <https://community.learningequality.org/>`__
+- IRC: **#kalite** on Freenode
+- Twitter: `@ka_lite <http://twitter.com/ka_lite>`__
+- Mailing list: `[email protected] on Google Groups <https://groups.google.com/a/learningequality.org/forum/#!forum/dev>`__
+
+Contact Us
+^^^^^^^^^^
+
+Tell us about your project and experiences!
+
+-  Email: [email protected]
+-  Add your project to the map: https://learningequality.org/ka-lite/map/
+
+License information
+-------------------
+
+The KA Lite sourcecode itself is open-source `MIT
+licensed <http://opensource.org/licenses/MIT>`__, and the other included
+software and content is licensed as described in the
+`LICENSE <https://raw.github.com/learningequality/ka-lite/master/LICENSE>`__
+file. Please note that KA Lite is not officially affiliated with, nor
+maintained by, Khan Academy, but rather makes use of Khan Academy's open
+API and Creative Commons content, which may only be used for
+non-commercial purposes.
diff --git a/docs/installguide/advanced.rst b/docs/installguide/advanced.rst
@@ -21,7 +21,7 @@ Installing through pip or with setup.py
 For command line users with access to pip, you can install KA Lite from an
 online source like this::
 
-    $> pip install ka-lite
+    pip install ka-lite
 
 
 Static version
@@ -30,7 +30,7 @@ Static version
 If you need to run KA Lite with static dependencies bundled and isolated from
 the rest of your environment, you can run::
 
-    $> pip install ka-lite-static
+    pip install ka-lite-static
 
 
 Portable tarballs / zip files with setup.py
@@ -43,11 +43,11 @@ To unpack the package for installation, run:
 
 .. parsed-literal::
 
-   $> tar -xf ka-lite-static-|release|.tar.gz
+   tar -xf ka-lite-static-|release|.tar.gz
 
 Once it's unpacked, install it by entering the extracted directory and running::
 
-    $> sudo python setup.py install
+    sudo python setup.py install
 
 Beware that the PyPi sources do not contain assessment items, so you need to
 :url-pantry:`download the contentpack en.zip manually <content/contentpacks/en.zip>` (>700 MB)..
@@ -61,7 +61,8 @@ _________________________________________________
 We maintain a `PPA on Launchpad <https://launchpad.net/~learningequality/+archive/ubuntu/ka-lite>`_
 and if you are connected to the internet, this will also give you automatic updates.
 
-On Ubuntu, do this::
+To add the PPA as a repository on an apt-based system, you need to ensure that a few libraries are present, and then add our repository and the public key that packages are signed with::
+
 
     sudo apt-get install software-properties-common python-software-properties
     sudo su -c 'echo "deb http://ppa.launchpad.net/learningequality/ka-lite/ubuntu xenial main" > /etc/apt/sources.list.d/ka-lite.list'
@@ -152,7 +153,7 @@ it may be located somewhere else.
 
 Example of setting up kalite for the www-data user: ::
 
-    $> sudo su -s /bin/bash www-data
-    $> kalite manage setup
-    $> exit
+    sudo su -s /bin/bash www-data
+    kalite manage setup
+    exit