Eggs and Buildout Deployment in Python

Figure 1: Data Flow within Distutils/Setuptools Usage

Slides:

Four-Part In-Depth Presentation Sequence (not presented in class)

• An Introduction to the Virtualenv Sandbox (.pdf, .txt)
• Distutils: Packaging, Metadata and Pushups (.pdf, .txt)
• SetupTools: Python Eggs, Dependencies and Plugins (.pdf, .txt)
• Buildout: Precision Assembly, Repeatability, Islands (.pdf, .txt)

Condensed Slide Set Used in Actual Tutorial

• Eggs and Buildout Deployment in Python (.pdf, .txt)
• Additional Topics of Tutorial (.pdf, .txt)

Exercises from Tutorial:

1. Installing Tools for the Class

   $ cd /tmp

   $ wget http://peak.telecommunity.com/dist/ez_setup.py

   $ sudo python ez_setup.py

   $ sudo easy_install virtualenv

   $ sudo easy_install zc.buildout

2. Instantiating a Sandbox or Two

   $ virtualenv pycon -or-

   $ virtualenv --no-site-packages pycon

   $ cd pycon

   $ bin/python

   $ source bin/activate -or- activate.bat

   $ deactivate

   • explore:

     • directory tree
     • sys.path

   • for each kind of sandbox

3. Processing Distributions

   1. Grab a source distribution

      $ /sandbox/bin/easy_install --editable --build-directory . SQLObject==0.9.5

      $ /sandbox/bin/easy_install --editable --build-directory . SQLObject==dev

      Examine its directory structure and common files.

   2. Query the list of available distribution formats.

      $ cd sqlobject

      $ /sandbox/bin/python setup.py sdist --help-formats

      $ /sandbox/bin/python setup.py bdist --help-formats

   3. Build and package it as a binary distribution.

      $ /sandbox/bin/python setup.py build

      $ /sandbox/bin/python setup.py install

      $ /sandbox/bin/python setup.py bdist --formats=tar,egg,rpm

      Examine the run output and the table-of-contents of the distribution archive afterward. Note the way that metadata is stored.

   4. Repackage it as a source distribution

      $ /sandbox/bin/python setup.py sdist --formats=zip

      Examine the run output and the table-of-contents of the source archive. Note the different way that metadata is stored.

   5. Try to import it, then run the "develop" cmd and try again.

      $ cd /sandbox

      $ /sandbox/bin/python

      $ import sqlobject
      $ cd /sandbox/sqlobject

      $ /sandbox/bin/python setup.py develop

4. Generating Scripts that Invokes Entrypoints

   1. Create a sandbox in which to work.

      $ virtualenv --no-site-packages pycon

      $ cd pycon

   2. Create a distribution for a new egg that has two scripts.

      # File: pycon/setup.py

      from setuptools import setup