I spent a little time getting familiar with the life-cycle steps of publishing a Python package…
- working with code on github (https://github.com/thebjorn/dk) Hint: use their windows application, it makes everything very streamlined.
- figuring out setup.py so that the package is uploaded to PyPI and others can install it with `pip install dk` (https://pypi.python.org/pypi/dk/0.7.4). Hint: if you don’t increase the version number, nothing good happens.
- Creating a home page using GitHub Pages (http://thebjorn.github.io/dk/). Hint: editing it after you’ve created it is the same process as creating it for the first time (don’t worry you’re not going to clobber everything you did the first time).
- Extracting docstrings using autodoc into Sphinxdoc documentation and integrating it with Read the Docs (http://dk.readthedocs.org/en/latest/). Hint: if using autodoc you’ll need to check the box for building in a virtualenv.
- Setting up a trigger so the documentation is automatically re-built every time I push to github.
Everything was pretty straight forward, and I especially like the webhook to re-build the documentation (since developers + manual steps = fail).
The remaining steps are a bit more hazy…, the remaining steps being the running of the test suite and reporting test failures + coverage. Perhaps tox is the answer…?