How to help¶
Markus is used in production in a few places, but I’d love to know how you use Markus and how Markus’ API works for you. Is it easy? Are there thing that are hard?
If you encounter any bugs, please write up an issue in the issue tracker.
Writing up issues¶
Please write up issues in the issue tracker.
If the issue is about a bug in Markus, please specify:
the version of Markus that you’re using
the version of Python that you’re using
the traceback and error message if applicable
These things will help me figure out the problem faster.
Install for hacking¶
# Clone the repository $ git clone https://github.com/willkg/markus # Create a virtualenvironment ... # Install Markus and dev requirements $ pip install -r requirements-dev.txt
Documentation is written in restructuredText and is in the
directory. We use Sphinx
to build documentation.
Run tests with tox. This will run all tests across all supported Python versions.
Tests are located in the
Checkout master tip and create a prep branch like
Check to make sure
setup.pyand requirements files have correct versions of requirements.
Update version numbers in
__version__to something like
__releasedate__to something like
Set the date for the release.
Make sure to note any backwards incompatible changes.
Run tests with
Build docs (this runs example code).
Verify all that works.
Push that branch and create a PR. If that passes, then merge it.
Check out and update master branch locally.
Tag the release:
$ git tag -a v0.4.0
Copy the details from
HISTORY.rstinto the tag comment.
$ git push --tags origin master
Update PyPI–do this in a Python3 virtualenv:
$ rm -rf dist/* $ python setup.py sdist bdist_wheel $ twine upload dist/*
Announce the release with a blog post and tweet.