Skip to main content

Setuptools extension to release an egg

Project description

Report any bug or feature requests to :

What is collective.releaser ?

collective.releaser provides command line utilities to make it easier to release and deploy zc.buildout/subversion based projects.

It provides:

  • new setuptools commands

  • release: used to release an egg-based package

  • build_mo: used to search and compile .po file

  • console scripts

  • project_release: used to release a buildout based project

  • project_deploy: used to deploy a buildout based project

  • project_copy_eggs: used to collect all eggs used in a project

  • project_md5: used to compute the MD5 hash of a buildout project

  • package_svn_prepare: to restructure a new created package to be svn ready

  • a hook to be able to launch actions when a package is released, with a default one that sends an email on each release.

  • a paste template to create a project structure, called releaser_project.

How to install collective.releaser ?

To install collective.releaser, you just need to run easy_install:

$ easy_install collective.releaser

or you can launch its setup if you have downloaded it:

$ python install

How to use collective.releaser ?

To work with collective.releaser, let’s do a small tutorial on how to create a buildbout-based project. This is done in a few steps:

  • setting up your environment

  • creating the project structure

  • creating egg-based packages

  • releasing eggs

  • releasing the buildout

  • upgrading an existing buildout

Setting up your environement

The first thing to do to work smoothly with zc.buildout is to set up a few things on your environment that apply globally to any Buildout-based applications.

Put two files in your home directory:

  • HOME/.buildout/.httpauth: this file will contain the authentication information if the system tries to reach a http(s) ressource which is password protected (like a svn server or a private web site). It is a text file where each line is: realm,url,user,password

    For example:


    This is used by lovely.buildouthttp.

  • HOME/.buildout/default.cfg: This file set some defaults values, so Buildout can cache and spare downloaded eggs.

    For example:

    download-cache = /home/tarek/.buildout/downloads
    eggs-directory = /home/tarek/.buildout/eggs

Next, you need to make sure you can release your eggs to several targets, because you may want some private eggs not to be published on PyPI. At this time, the only software that provides the same web services than PyPI is Plone Software Center >= 1.5.

To make it possible to handle several PyPI-like servers, we need to install a small add-on, called collective.dist:

$ easy_install collective.dist

This will allow you to define several servers in your ~/.pypirc file. For instance if you are working with a private PyPI-like server you can define it like this in HOME/.pypirc

index-servers =



Last, you need to define the release strategy configuration, that will define for each target server the list of packages that must be released there (regular expressions) and the command sequence that is used with Here’s a default example, that can be added in your .pypirc as well, by completing the sections with release-command and release-packages variables:


release-command = mregister sdist build_mo bdist_egg mupload
release-packages =

release-command = mregister sdist build_mo bdist_egg mupload
release-packages =

This will push all eggs that starts with plone. or collective. to PyPI and all eggs that starts with iw. to ingeniweb-public. The command used to push the packages are defined by command.

Creating the project structure

Every project must be structured the same way:

$ paster create -t releaser_project my_project

This will ask you for a few values:

  • project_name: the name of the project

  • project_repo: the root of the subversion repository

  • some more values that can be left to default.

This will generate a set of folders in my_project:

$ ls my_project

Each folder has a role:

  • buildout: contains the buildout configuration files

  • bundles: contains the bundle used to work in develop mode

  • docs: contains the documentation about the project

  • packages: contains the egg-based package(s)

  • releases: contains the releases of the buildout

This structure must be commited in subversion:

$ svn import my_project http://some.svn/my_project -m "initial commit"

You will then be able to work in your buildout.

Creating egg-based package

From there you can add some packages into the project, by putting them in the packages folder, by using any template available in ZopeSkel.

Be carefull though, you must use a trunk/tags/branches structure in packages for each project.

$ cd my_projet/packages
$ paster create -t plone plone.example
$ package_svn_prepare plone.example

The last command just does the following:

$ mv plone.example plone.example_md5_of_plone.example
$ mkdir plone.example
$ mkdir plone.example/tags plone.example/branches
$ mv plone.example_md5_of_plone.example plone.example/trunk
$ svn add plone.example
$ svn ci -m "initial import of  plone.example"

Do not use trunk as a package name with paster, as this will generate bad metadata in the package.

A special section can be added into setup.cfg, in order to send a mail everytime the package is released:

hook = collective.releaser:mail
from =
emails =

If your system does not have a SMTP server, you will need to add the name of a SMTP server, and its port in your .pypirc file, in a mail_hook section:

host =
port = 25

From there you can bind the package to your buildout, with a develop variable, in your my_project/buildout folder:


The bundle folder can also be used to set svn:externals to make it simpler to work in the buildout.

Releasing eggs

Releasing eggs is done by calling release from a package:

$ python release
running release
This package is version 0.1.2
Do you want to run tests before releasing ? [y/N]: N
Do you want to create the release ? If no, you will just be able to deploy again the current release [y/N]: Y
Enter a version [0.1.2]: 0.1.2
Commiting changes...
Creating branches...

This will take care of:

  • upgrading the version

  • creating a branch and a tag in svn

  • pushing the package to the various PyPI-like servers

  • sending a mail with the changes, if the mail_hook section was provided in setup.cfg

If you want to release a package from a non-svn folder then use this command to disable specific svn hooks:

$ python release --pre-hook --post-hook

You can also use some parameters to avoid command line prompt:

$ python release -a --version=0.1.3

Releasing the project

Releasing the project consists of calling project_release then project_deploy.

project_release will just create a new branch in subversion:

$ cd my_project/buildout
$ project_release --no-archive --version=0.1

This will copy my_project/buildout to my_project/releases/0.1 in subversion. You can then work in this release, to pinpoint the versions in your buildout. A good practice is to create a dedicated cfg file for deployment.

The next step is to generate a tarball with project_deploy:

$ cd /tmp
$ svn co http://somesvn/my_projet/releases/0.1 my_project
$ cd my_project
$ project_deploy prod.cfg

This will build a tarball in /tmp using VirtualEnv, and set everything up so the buildout can be reinstalled offline anywhere with this archive.

The resulting release can be installed with two lines:

$ python
$ bin/buildout

Upgrading an existing buildout

To upgrade an existing buildout, you can use the project_release command. It will create a tarball with all eggs needed to run the project and the .cfg files.

Run it in your buildout, by pointing the .cfg and by providing a name of the archive:

$ cd my_project/buildout
$ project_release --version=0.2

This will release all develop eggs found in dev.cfg. If your dev.cfg look like:

parts = eggs
develop =

recipe = zc.recipe.egg
eggs =

Then my.package and my.other will be released and then added to an archive with all .cfg files.

If you have a static version in your prod.cfg:

parts = eggs
versions = versions

my.package = 0.1

recipe = zc.recipe.egg
eggs =

Then only my.other will be released but both added to the archive.

The default config file of the archive (eg: buildout.cfg) will look like this:

extends = prod.cfg
versions = versions


So you can just run ./bin/buildout on your production server to use the correct packages versions.

0.7.1 (2010-12-08)

  • Fixed issue with mingw32 not working inside the virtualenv, by making sure we copy the distutils.cfg file. [deo]

0.7.0 (2010-09-30)

  • Added some fixes to make (most) tests pass on Windows. [dreamcatcher]

  • Fixed issue with broken target file on project_deploy. [dreamcatcher]

  • Changed to only upgrade setuptools/zc.buildout if requested. [deo]

  • Added a dependency on virtualenv instead of shipping with an outdated version which potentially can damage your development environment. [deo]

0.6.6 (2009-09-17)

  • Made sure to resolve the filename to use an absolute path. [gawel]

  • Made sure that our package is in sys.path before releasing. [gawel]

  • Fixed ReST formatting issue. [gawel]

0.6.5 (2009-08-31)

0.6.4 (2009-08-18)

  • More docs and sphinxifying docs. [gawel]

0.6.3 (2009-08-18)

0.6.2 (2008-04-09)

  • make sure the works offline [tarek]

  • fixed build_mo command for Django eggs [b_mathieu]

0.6.1 (2008-07-16)

  • adding a buildbot folder, with a pre-generated collective.buildbot environment [tarek]

  • prefacing all svn commit messages [tarek]

  • better tarball naming [tarek]

  • introduced glob-style option to be able to do glob-style patterns [tarek]

  • removed branch creation [tarek]

0.6.0 (2008-07-16)

  • fixed project_deploy so it supports non buildout.cfg buildouts Thanks to Hans-Peter Locher for feedback [tarek]

  • using Popen to read metadata [tarek]

0.5.2 (2008-06-19)

  • now checking the long_description field to make sure it is reST compliant [tarek]

  • backported Python 2.5 tarfile module [tarek]

  • fixed #66 [tarek]

0.5.1 (2008-06-10)

  • emptied parts section in the template/ [tarek]

  • os.rename -> shutil.move [tarek]

  • added paster() in testing to ease tests [tarek]

  • Fix empty or missing parts under windows when the recipe use subversion [encolpe]

0.5.0 (2008-05-21)

  • moved to collective [tarek]

  • added package_svn_prepare command to restructure a new created package with trunk, tags and branches then add it to the current working copy and ci it to svn as ‘initial import’ if the current directory is a working copy. [mustapha]

0.4.1 (2008-04-29)

  • now release can be driven from .pypirc as well [tarek]

  • We are not removing setup.cfg in releases anymore, because it can have elements. We just remove the dev tag. [tarek]

0.3.6 (2008-04-29)

  • wrote the documentation [tarek]

  • added the iw_plone_project template [tarek]

  • release command take care of version.txt if any [gawel]

  • add release hook [gawel]

0.3.5 (2008-04-22)

  • added the project_eggs command [tarek]

  • now adding a MD5 file in the tarball released [tarek]

  • added project_md5 [tarek]

0.3.4 (2008-04-17)

  • added project_copy_eggs [tarek]

0.3.3 (2008-04-17)

  • Excluding Scripts, Lib and downloads/dist [tarek]

0.3.2 (2008-04-17)

  • protecting shutil.rmtree call [tarek]

  • make the python prompt generation smarter [tarek]

  • remove stale bytecode by default. (This mean –keepbytecode has to be used in order for the test to work) [tarek]


  • fixed os.curdir misusage

  • fixed build_mo (indent error)

  • fixed over simple build_mo tests by adding garbage files


  • fixed a missing import


  • removed parts, bin, lib and other folders from the release. We will have a special mode later to provide them when a pre-built is needed.

  • fixed the project_diff target location


  • now has a config file to target the pypi servers

  • project_release was not working with svn:// repositories


  • copying the libpython*.a file into buildout’s libs folder, so virtualenv works with MinGW under windows.

  • added a version.txt file in the releases.


  • making sure we get virtualenv python2.4.*

  • cleaned up tarball content

  • making project_deploy work within the same folder


  • removed extra questions in project_release

  • fixed release name

  • fixed checkouts


  • added project_diff


  • make sure virtualenv (some version under win32) work with Scripts/python


  • make sure virtualenv work with ‘python’ or ‘python2.4’

  • the auto mode for package release is not launching the tests anymore

  • fixed msgfmt type comparison


  • making sure the right cfg file is called with project_deploy


  • added ‘build_mo’ command for setuptools

  • fix project_release relative paths

  • explicitely uses ingeniweb-private to release package


  • fix CR/LF


  • fix multiple upload


  • removing eggchecker


  • make sure we don’t release by accident on unwanted server


  • fixed the caller

  • using virtualenv to isolate egg on project_deploy step


  • added command line options


  • making sure download-cache is present

  • added a snapshot file that is commited in the buildout that is beeing released

  • now tarball can contain only diffs from snapshots

  • added iw.dist support


  • release step is not mandatory anymore


  • removed eggchecker dependency


  • renamed release module to packet module

  • implemented a project release-r


  • initial version created by IngeniSkel

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.releaser-0.7.1.tar.gz (96.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page