Guidelines

• pep8 compliant with some exceptions (see pytest.ini)

• 100% test coverage with pytest (with valid tests) (note that until https://github.com/lemurheavy/coveralls-public/issues/31 is fixed, you need to check the cov output for branch coverage, coveralls can’t be relied on).

Testing

Testing is done via pytest, driven by tox.

• testing is as simple as:

  • pip install tox

  • tox

• If you want to see code coverage: tox -e cov

  • this produces two coverage reports - a summary on STDOUT and a full report in the htmlcov/ directory

• 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

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 __init__.py 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, confirm that README.rst renders correctly.

   • Make sure your ~/.pypirc file is correct

   • python setup.py register -r https://testpypi.python.org/pypi

   • python setup.py sdist upload -r https://testpypi.python.org/pypi

   • Check that the README renders at https://testpypi.python.org/pypi/pypuppetdb-daily-report

8. Create a pull request for the release to be merge 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 -a vX.Y.Z -m 'X.Y.Z released YYYY-MM-DD'

   • push the tag to GitHub: git push origin vX.Y.Z

11. Upload package to live pypi:

    • python setup.py sdist upload

10. make sure any GH issues fixed in the release were closed.