Common utilies for Django used at TrackMaven

Docs are avaible here.

Installation

$ pip install trackmaven-django --extra-index-url https://pypi.fury.io/trackmaven/

If you want to include this on a requirements.txt, use the following syntax...

<other packages>
--extra-index-url https://pypi.fury.io/trackmaven/
trackmaven-django==0.0.2

Development

Inside of a virtualenv, to install the required packages, run

pip install -e .
pip install -r requirements-dev.txt

Or simply run

make setup

This project uses py.test as its test runner. To run the tests

make tests

or you can call py.test directly with...

py.test -vv

To run the test suite against all support Python versions (2.7 and 3.4) run...

tox

Docs

Documentation is generated by Sphinx. If you are unfamiliar with it, check out this handy cheatsheet.

To build the docs, run

make build-docs

To see the docs, after building, run

make serve-docs

Release Checklist

• Bump version in trackmaven_common/__init__.py
• Add changes to CHANGELOG.rst
• Open PR with title "Release <version>"
• Build + push dist to gemfury.

python setup.py sdist
curl -F package=@<file> https://<gemfury_token>@push.fury.io/trackmaven/

• Ensure tests pass.
• Merge PR to master.
• Added release to GitHub https://github.com/TrackMaven/trackmaven-django/releases with changelog notes.