Development¶

Development of Manwë happens on GitHub: https://github.com/varda/manwe

Contributing¶

Contributions to Manwë are very welcome! They can be feature requests, bug reports, bug fixes, unit tests, documentation updates, or anything els you may come up with.

Coding style¶

In general, try to follow the PEP 8 guidelines for Python code and PEP 257 for docstrings.

Unit tests¶

To run the unit tests with pytest, just run:

$ py.test

The tests use Varda, so you need to have that installed (just the Python package, no configuration needed) along with its dependencies.

Versioning¶

A normal version number takes the form X.Y.Z where X is the major version, Y is the minor version, and Z is the patch version. Development versions take the form X.Y.Z.dev where X.Y.Z is the closest future release version.

Note that this scheme is not 100% compatible with SemVer which would require X.Y.Z-dev instead of X.Y.Z.dev but compatibility with setuptools is more important for us. Other than that, version semantics are as described by SemVer.

Releases are published at PyPI and available from the GitHub git repository as tags.

Release procedure¶

Releasing a new version is done as follows:

Make sure the section in the CHANGES file for this release is complete and there are no uncommitted changes.

Note

Commits since release X.Y.Z can be listed with git log vX.Y.Z.. for quick inspection.
Update the CHANGES file to state the current date for this release and edit manwe/__init__.py by updating __date__ and removing the dev value from __version_info__.

Commit and tag the version update:
```
git commit -am 'Bump version to X.Y.Z'
git tag -a 'vX.Y.Z'
git push --tags
```
Upload the package to PyPI:
```
python setup.py sdist upload
```
Add a new entry at the top of the CHANGES file like this:
```
Version X.Y.Z+1
---------------

Release date to be decided.
```
Increment the patch version and add a dev value to __version_info__ in manwe/__init__.py and commit these changes:
```
git commit -am 'Open development for X.Y.Z+1'
```