Releasing a new version

This project uses flit and bumpver for this process. These are the steps needed to release a new version:

  1. Install the dependencies:

    $ pip install flit bumpver
    
  2. Update the CHANGELOG.rst with the changes included in this release

  3. Add CHANGELOG.rst to git stage:

    $ git add CHANGELOG.rst
    
  4. Increase version (--patch, --minor or --major):

    $ bumpver update --minor --allow-dirty
    
  5. Build the package and check everything is correct:

    $ rm -rf dist/ build/
    $ flit build
    
  6. Upload the package to PyPI:

    $ flit publish