moving skeleton from kolibri_skeleton repo

.coveragerc

@@ -0,0 +1,8 @@
+[run]
+branch = true
+
+[report]
+show_missing = true
+precision = 2
+exclude_lines = raise NotImplementedError
+

.gitignore

@@ -1,62 +1,49 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
 *.py[cod]
-*$py.class
 
 # C extensions
 *.so
 
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
+# Packages
+.cache
+.eggs
 *.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
 
 # Installer logs
 pip-log.txt
-pip-delete-this-directory.txt
 
 # Unit test / coverage reports
-htmlcov/
-.tox/
 .coverage
-.coverage.*
-.cache
+.tox
 nosetests.xml
-coverage.xml
-*,cover
-.hypothesis/
 
 # Translations
 *.mo
-*.pot
 
-# Django stuff:
-*.log
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.venv
 
-# Sphinx documentation
-docs/_build/
+# Complexity
+output/*.html
+output/*/index.html
 
-# PyBuilder
-target/
+# Sphinx
+docs/_build
 
-# PyCharm
-.idea
+# api-docs
+docs/kolibri*rst
+docs/modules.rst

.travis.yml

@@ -0,0 +1,30 @@
+# Config file for automatic testing at travis-ci.org
+
+language: python
+
+sudo: false
+
+python:
+  - "3.4"
+  - "3.5"
+  - "2.7"
+# pypy testing currently breaks because of the tempfile dir used for KALITE_HOME
+#  - "pypy"
+
+before_install:
+  - pip install codecov
+  - pip install tox
+
+before_script:
+  - tox -e lint
+
+# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
+install: 
+  - TOX_ENV=py${TRAVIS_PYTHON_VERSION}
+
+# command to run tests, e.g. python setup.py test
+script:
+  - tox -e $TOX_ENV
+
+after_success:
+  - codecov

AUTHORS.rst

@@ -0,0 +1,16 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Learning Equality <info@learningequality.org>
+
+
+Community
+--------- 
+
+Please feel free to add your name on this list if you do a PR!
+
+* Your name here / github username

CHANGELOG.rst

@@ -0,0 +1,14 @@
+.. :changelog:
+
+=============
+Release notes
+=============
+
+*Don’t let your friends dump git logs into CHANGELOGs™*
+
+http://keepachangelog.com/
+
+Kolibri 0.0.1
++++++++++++++
+
+* This is a test skeleton!

CONTRIBUTING.rst

@@ -0,0 +1,109 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given. 
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/learningequality/kolibri/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Kolibri could always use more documentation, whether as part of the 
+official Kolibri docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/learningequality/kolibri/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `kolibri` for
+local development.
+
+1. Fork_ the `kolibri` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/kolibri.git
+
+3. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+Now you can make your changes locally.
+
+4. When you're done making changes, check that your changes pass style and unit
+   tests, including testing other Python versions with tox::
+
+    $ tox
+
+To get tox, just pip install it.
+
+5. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+.. _Fork: https://github.com/learningequality/kolibri/fork
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy.
+   Check https://travis-ci.org/learningequality/kolibri 
+   under pull requests for active pull requests or run the ``tox`` command and
+   make sure that the tests pass for all supported Python versions.
+
+
+Tips
+----
+
+To run a subset of tests::
+
+	 $ py.test test/test_kolibri.py

LICENSE

@@ -1,18 +1,20 @@
-Copyright for the Kolibri software, except where otherwise specified in the code or further down in this file, belongs
-to the Foundation for Learning Equality, Inc. (FLE), and by contributing your code to this project (except where
-otherwise negotiated), you agree to assign copyright in this code to FLE, to be licensed under the same terms as the
-rest of the code. The Kolibri codebase is released for use under the open-source MIT license
-(see http://opensource.org/licenses/MIT):
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
-rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
-persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2015 Learning Equality
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
-Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,5 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include CHANGELOG.rst
+include LICENSE
+include README.rst

Makefile

@@ -0,0 +1,55 @@
+.PHONY: help clean clean-pyc clean-build list test test-all coverage docs release sdist
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "testall - run tests on every Python version with tox"
+	@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"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc clean-docs
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+clean-docs:
+	rm -f docs/kolibri*rst
+	rm -f docs/modules.rst
+	$(MAKE) -C docs clean
+
+lint:
+	flake8 kolibri
+
+test:
+	python setup.py test
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source kolibri setup.py test
+	coverage report -m
+
+docs: clean-docs
+	sphinx-apidoc -d 10 -H "Python Reference" -o docs/ kolibri kolibri/test kolibri/deployment/
+	$(MAKE) -C docs html
+
+release: clean
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+sdist: clean
+	python setup.py sdist
+	python setup.py bdist_wheel upload
+	ls -l dist