Preparing an Add on release

If making release for the first time

1. Make a PyPI and PyPI Test account if you do not have them yet and ask an administrator for permission to upload on PyPI.

2. Make sure that you have your usernames and passwords for PyPI stored in the ~/.pypirc file which should look like this:

   [distutils]
   index-servers=
       pypi
       testpypi
   
   [testpypi]
   repository: https://test.pypi.org/legacy/
   username: <your username>
   password: <your password>
   
   [pypi]
   username: <your username>
   password: <your password>
   

3. Install Twine: pip install twine if you do not have it installed yet.

Release making

1. Change a version in a setup.py

2. Build a documentation

   cd doc
   make htmlhelp
   cd ..
   

3. Run

    python setup.py sdist
    python setup.py bdist_wheel
   

4. Test release with installing dist/<filename>.tar.gz:

    pip install <path to the addon>/dist/<filenam>.tar.gz
   

5. Make a release: twine upload dist/<latest tar.gz>

6. Make new tag on the Github:

   git add setup.py
   git commit -m "Release <release number>"
   git push upstream master
   git tag <release number>
   git push upstream --tags
   

7. For add-ons available at conda-forge: Make a pull request on the appropriate conda-forge repository.