Release Process

This process describes the steps to execute in order to release a new version of SimPy.


  1. Close all tickets for the next version.

  2. Update the minium required versions of dependencies in Update the exact version of all entries in requirements.txt.

  3. Run tox from the project root. All tests for all supported versions must pass:

    $ tox
    ________ summary ________
    py27: commands succeeded
    py32: commands succeeded
    py33: commands succeeded
    pypy: commands succeeded
    congratulations :)


    Tox will use the requirements.txt to setup the venvs, so make sure you’ve updated it!

  4. Build the docs (HTML is enough). Make sure there are no errors and undefined references.

    $ cd docs/
    $ make clean html
    $ cd ..
  5. Check if all authors are listed in AUTHORS.txt.

  6. Update the change logs (CHANGES.txt and docs/about/history.rst). Only keep changes for the current major release in CHANGES.txt and reference the history page from there.

  7. Commit all changes:

    $ hg ci -m 'Updated change log for the upcoming release.'
  8. Write a draft for the announcement mail with a list of changes, acknowledgements and installation instructions. Everyone in the team should agree with it.

Build and release

  1. Test the release process. Build a source distribution and a wheel package and test them:

    $ python sdist
    $ python bdist_wheel
    $ ls dist/
    simpy-a.b.c-py2.py3-none-any.whl simpy-a.b.c.tar.gz

    Try installing them:

    $ rm -rf /tmp/simpy-sdist  # ensure clean state if ran repeatedly
    $ virtualenv /tmp/simpy-sdist
    $ /tmp/simpy-sdist/bin/pip install pytest
    $ /tmp/simpy-sdist/bin/pip install --no-index dist/simpy-a.b.c.tar.gz
    $ /tmp/simpy-sdist/bin/python
    >>> import simpy
    >>> simpy.__version__  # doctest: +SKIP
    >>> simpy.test()  # doctest: +SKIP


    $ rm -rf /tmp/simpy-wheel  # ensure clean state if ran repeatedly
    $ virtualenv /tmp/simpy-wheel
    $ /tmp/simpy-wheel/bin/pip install pytest
    $ /tmp/simpy-wheel/bin/pip install --use-wheel --no-index --find-links dist simpy
    $ /tmp/simpy-wheel/bin/python
    >>> import simpy  # doctest: +SKIP
    >>> simpy.__version__  # doctest: +SKIP
    >>> simpy.test()  # doctest: +SKIP
  2. Create or check your accounts for the test server <> and PyPI. Update your ~/.pypirc with your current credentials:

    index-servers =
    repository =
    username = <your test user name goes here>
    password = <your test password goes here>
    repository =
    username = <your production user name goes here>
    password = <your production password goes here>
  3. Register SimPy with the test server and upload the distributions:

    $ python register -r test
    $ python sdist upload -r test
    $ python bdist_wheel upload -r test
  4. Check if the package is displayed correctly:

  5. Test the installation again:

    $ pip install -i simpy
  6. Update the version number in simpy/, commit and create a tag:

    $ hg ci -m 'Bump version from a.b.c to x.y.z'
    $ hg tag x.y.z
    $ hg push ssh://
  7. Finally upload the package to PyPI and test its installation one last time:

    $ python register
    $ python sdist upload
    $ python bdist_wheel upload
    $ pip install simpy
  8. Check if the package is displayed correctly:

  9. Activate the documentation build for the new version.

Post release

  1. Send the prepared email to the mailing list and post it on Google+.
  2. Update Wikipedia entries.
  3. Update Python Wiki
  4. Post something to Planet Python (e.g., via Stefan’s blog).