How to Make a Release¶

1. Make sure ProDy imports and passes all unit tests both Python 2 and Python 3, and using nose nosetests command:

   $ cd ProDy
   $ nosetests
   $ nosetests3

   See Testing ProDy for more on testing.

2. Update the version number in:

   • prody/__init__.py

   Also, commend + '-dev' out, so that documentation will build for a stable release.

3. Update the most recent changes and the latest release date in:

   • docs/release/vX.Y_series.rst.

   If there is a new incremental release, start a new file.

4. Make sure the following files are up-to-date.

   • README.txt
   • MANIFEST.in
   • setup.py

   If there is a new file format, that is a new extensions not captured in MANIFEST.in, it should be included.

   If there is a new C extension, it should be listed in setup.py.

   After checking these files, commit change and push them to GitHub.

5. Generate the source distributions:

   $ cd ..
   $ python setup.py sdist --formats=gztar,zip

6. Prepare and test Windows installers (see Making Windows Installers):

   $ C:\Python26\python setup.py bdist_wininst
   $ C:\Python27\python setup.py bdist_wininst
   $ C:\Python32\python setup.py bdist_wininst
   $ C:\Python33\python setup.py bdist_wininst

   Alternatively, use bdist_wininst.bat to run these commands. When there is a newer Python major release, it should be added to this list.

7. Register new release to PyPI:

   $ python setup.py register

8. Upload the new release files to the PyPI.

9. Commit final changes, if there are any:

   $ cd ..
   $ git commit -a

10. Tag the repository with the current version number:

    $ git tag vX.Y

11. Rebase devel branch to master:

    $ git checkout master
    $ git rebase devel

12. Push the changes with the new tag:

    $ git checkout master
    $ git push --tags
    $ git checkout devel
    $ git push --tags

13. Finally, update the documentation on ProDy website. See Documenting ProDy.

14. Now that you made a release, you can go back to development. You may stat with append '-dev' to __release__ in prody/__init__.py.