To install for development:

  1. Fork the python-package-skeleton repository on GitHub
  2. Create a new branch off of master in your fork.
$ virtualenv python-package-skeleton
$ cd python-package-skeleton && source bin/activate
$ pip install -e
$ cd src/python-package-skeleton

The git clone you’re now in will probably be checked out to a specific commit, so you may want to git checkout BRANCHNAME.


  • pep8 compliant with some exceptions (see pytest.ini)
  • 100% test coverage with pytest (with valid tests)


Testing is done via pytest, driven by tox.

  • testing is as simple as:
    • pip install tox
    • tox
  • If you want to pass additional arguments to pytest, add them to the tox command line after “–”. i.e., for verbose pytext output on py27 tests: tox -e py27 -- -v

Alembic Database Migrations

This project uses Alembic for DB migrations:

  • To generate migrations, run alembic -c motion_pipeline/alembic/alembic.ini revision --autogenerate -m "message" and examine/edit then commit the resulting file(s). This must be run before the model changes are applied to the DB. If adding new models, make sure to import the model class in models/
  • To apply migrations, run alembic -c motion_pipeline/alembic/alembic.ini upgrade head.
  • To see the current DB version, run alembic -c motion_pipeline/alembic/alembic.ini current.
  • To see migration history, run alembic -c motion_pipeline/alembic/alembic.ini history.

Release Checklist

  1. Open an issue for the release; cut a branch off master for that issue.
  2. Confirm that there are CHANGES.rst entries for all major changes.
  3. Ensure that Travis tests passing in all environments.
  4. Ensure that test coverage is no less than the last release (ideally, 100%).
  5. Increment the version number in python-package-skeleton/ and add version and release date to CHANGES.rst, then push to GitHub.
  6. Confirm that README.rst renders correctly on GitHub.
  7. Upload package to testpypi:
  8. Create a pull request for the release to be merged into master. Upon successful Travis build, merge it.
  9. Tag the release in Git, push tag to GitHub:
    • tag the release. for now the message is quite simple: git tag -s -a X.Y.Z -m 'X.Y.Z released YYYY-MM-DD'
    • push the tag to GitHub: git push origin X.Y.Z
  1. Upload package to live pypi:
    • twine upload dist/*
  1. make sure any GH issues fixed in the release were closed.