Buildout steps

Buildout steps

• Bootstrap the buildout:

  python bootstrap.py
  

  handout

  This installs setuptools and zc.buildout locally in your buildout. This avoids changing your system Python.

• Run the buildout:

  bin/buildout
  

  handout

  This generates the test script, bin/test.

• Run the tests:

  bin/test
  

• Generate a distribution:

  bin/buildout setup . sdist register upload
  bin/buildout setup . bdist_egg register upload
  

  bin/buildout setup . egg_info -rbdev sdist register upload
  

  handout

  Buildout accepts a number of commands, one of which is setup. The setup command takes a directory name and runs the setup script found there. It arranges for setuptools to be imported before the script runs. This causes setuptools defined commands to work even for distributions that don't use setuptools.

  The sdist, register, upload, bdist_egg, and egg_info commands are setuptools and distutils defined commands.

  The sdist command causes a source distribution to be created.

  The register command causes a release to be registered with PyPI and the upload command uploads the generated distribution. You'll need to have an account on PyPI for this to work, but these commands will actually help you set an account up.

  The bdist_egg command generates an egg.

  The egg_info command allows control of egg meta-data. The -r option to the egg_info command causes the distribution to have a version number that includes the subversion revision number of the project. The -b option specified a revision tag. Here we specified a revision tag of "dev", which marks the release as a development release. These are useful when making development releases.