Build¶
To run a complete development build:
(.venv) $ faff
Tests¶
To run the package test suite:
(.venv) $ faff tests
To run individual tests:
(.venv) $ python setup.py test -s tests.$NAME
To report coverage via Code Climate:
(.venv) $ export CODECLIMATE_REPO_TOKEN=$TOKEN
(.venv) $ codeclimate-test-reporter
To enable automated coverage reporting via Travis CI,
set the environment variable CODECLIMATE_REPO_TOKEN in settings.
Change Log¶
To set the Git message template:
$ git config --global commit.template .gitmessage
To generate a change log:
(.venv) $ faff changelog
Release¶
To build a release:
- Run a development build with release flag.
- Clean up change log, commit and tag with version number.
- Push to remotes with tags, create release on GitHub.
- Upload package/documentation to PyPI.
- Update version number in
setup.py,faff/__init__.py.
(.venv) $ faff all --release $VERSION
(.venv) $ # Clean up change log.
(.venv) $ # Create commit.
(.venv) $ git tag $VERSION
(.venv) $ git push origin master --tags
(.venv) $ twine upload dist/*