Development

Some simple instructions for the development of PyKleen.

Setup

Setup your virtual environment, activate it and install the requirements.

virtualenv --no-site-packages -p `which python3.5` venv
source venv/bin/activate
pip install -r requirements.txt
deactivate && source venv/bin/activate

Development

While doing your development run:

PYTHONPATH=. ptw

Or, when you don’t want to keep the test running:

python setup.py test

After you are finished, you need to update the documentation:

cd docs && make livehtml

Release

  1. Update the version number in VERSION.
  2. Run the tests once more (better to be sure, right?).
  3. Commit and push to GIT.
  4. Release the code.
echo "X.X" > VERSION
python setup.py test
ga . && gc -m 'Bump to version X.X' && gp
python setup.py sdist upload -r pypi