Python setuptools

From Exterior Memory
Revision as of 00:21, 26 August 2013 by MacFreek (Talk | contribs) (Release Steps)

Jump to: navigation, search

The most common way to distribute Python modules is using PyPI, the Python Package Index (formerly known as the Cheese shop).

The tool to download and install packages is pip. Predecessors like EasyInstall are no longer recommended, with only a few exceptions.

There are tool to build and upload packages is or setuptools. Make sure to use version 0.7 or later.

There are a few alternatives to setuptools: distutils is a tool in the standard library with limited functionality. The downside of both distutils and setuptools is that they use a script rather than a file format to store metadata, and force the developer an end-user to use the same tool to build and install the software. distutils2 (the module will be named `package`) is an attempt to move to a modern packaging system for Python, but has not been included as of Python 3.4.

Release Steps

Credits: These steps are taken from the sphinxcontrib-aafig package.

In order to make a PyPi release, do the following steps:

  1. Make sure the repository is up-to date.
  2. Ensure the version is incremented:
    • must be updated
    • libary/ must be updated
    • doc/changes.rst must contain a summary of the changes
  3. Make sure all changes are committed, including the version number changes.
  4. Tag the sources with hg tag -m 'Tag mymodule-X.Y' mymodule-X.Y or git tag mymodule-X.Y.
  5. Push the code and tag: hg push or git push --tags origin
  6. Temporarily modify setup.cfg file to comment out the variables tag_build = dev and tag_date = true (do not commit this change).
  7. Register and upload the new release <codde>python register sdist upload</code>.
  8. Generate the documentation with cd doc; make.
  9. Upload the new documentation (to PyPi or to github repository).