Contributing to Madoop

Install development environment

Set up a development virtual environment.

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install --editable .[dev]

A madoop entry point script is installed in your virtual environment.

$ which madoop
/Users/awdeorio/src/mailmerge/.venv/bin/madoop

Run unit tests

$ pytest
$ pytest -vv --log-cli-level=DEBUG  # More output

Measure unit test case coverage

$ pytest --cov ./madoop --cov-report term-missing

Test code style

$ pycodestyle madoop tests setup.py
$ pydocstyle madoop tests setup.py
$ pylint madoop tests setup.py
$ check-manifest

Run linters and tests in a clean environment. This will automatically create a temporary virtual environment.

$ tox -e py3

Update your local develop branch. Make sure it's clean.

$ git fetch
$ git switch develop
$ git rebase
$ git status

Test

$ tox -e py3

Update version

$ $EDITOR pyproject.toml
$ git commit -m "version bump" pyproject.toml
$ git push origin develop

Update main branch

$ git fetch
$ git switch main
$ git rebase
$ git merge --no-ff origin/develop

Tag a release

$ git tag -a X.Y.Z
$ grep version pyproject.toml
version = "X.Y.Z"
$ git describe
X.Y.Z
$ git push --tags origin main

Create a release on GitHub using the "Auto-generate release notes" feature. https://github.com/eecs485staff/madoop/releases/new

Upload to PyPI

$ python3 -m build
$ twine upload --sign dist/*