release.md

Package releases

The main location for EEGsynth development is on its GitHub repository.

Packaged versions of EEGsynth are released on PyPi.

Creating new releases

This tutorial explains the packaging and release process.

The following commands are used to publish a new release on PyPi:

pip install setuptools
pip install twine

edit setup.py     # insert the correct version number
git commit -a     # commit the version number change
git tag -a x.y.z  # tag this commit with the correct version number, see below
git push --tags

python setup.py sdist bdist_wheel
twine upload dist/*

Note: I tried both setuptools-version-command and better-setuptools-git-version to automatically use the git tag for the version number. They did not work consistently and caused incorrect version numbers upon installation.

Testing the release process

It is possible to test the packaging and distribution process using this:

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

pip install --extra-index-url https://test.pypi.org/simple/ eegsynth

It is possible to test the setup.py file by doing an install from the local repository like this:

pip install -e .

Version numbering

We use semantic versioning for the releases.