Introduction to the KGS

Available Versions

Version 3.5.0dev

• Controlled Packages
• Buildout Configuration
• Versions
• Package Links
• Minimal Index
• Index

Usage

This KGS was designed to work with many of the tools developed to manage and install Python pacakges. The following sub-sections will explain its use in more detail.

The Index

You can use the index directly. It then behaves exactely like http://pypi.python.org/simple, except that for the controlled packages only the good versions are available. The advantage of using the KGS as an index is that you get bug fixes automatically.

• Buildout, buildout.cfg:

            [buildout]
            index = http://download.project.org/kgs
            ...
          

• Setup Tools, easy_install

            $ easy_install -i http://download.project.org/kgs mypackage
          

Nailed or Pinned Versions

When deploying an application, it is often important to nail or pin down the versions of all used packages, so that it can be guaranteed that the setup is identical all the time.

• Buildout, buildout.cfg:

            [buildout]
            versions = versions
            ...
            [version]
            zope.interface = 3.4.0
            (copy the content here)
          

  or

            [buildout]
            extends = http://download.project.org/kgs/versions-1.0.0.cfg
          

• Setup Tools itself cannot use the version.cfg file.

Find Links

The way of providing the installation tools with additional locations to look for packages is via find links. Those URLs are expected to be an HTML page with links to files or files directly.

• Buildout, buildout.cfg:

            [buildout]
            find-links = http://download.project.org/kgs/links.html
            ...
          

• Setup Tools, easy_install

            $ easy_install -f http://download.project.org/kgs/links.html mypackage