CheesePrism 0.3

CheesePrism

Dev

$ cd CheesePrism
$ pip install -r tests-require.txt

$ nosetests -vv

$ paster serve development.ini

Production

CheesePrism doesn't pretend that it or python servers in general excel at serving flat files.

For a more durable and performantized setup, you will want to split the serving between a wsgi host for the management application and a industrial strength file server (say nginx).

.. todo::

  have start up announce static and file_root (and document)

$ paster serve prod.ini

Release into your index

CheesePrism understand the upload interface of pypi. This means for python2.6 and better you can setup your ~/.pypirc and then upload to your prism as you would pypi:

[distutils]
   index-servers =
       pypi
       local


[pypi]
   username:user
   password:secret

[local]
   # your prism of fromage
   username:user
   password:secret
   repository:http://mycheese/simple

The you can upload a source ala:

$  cd /src/MyAwesomePyPkg
$  python setup.py sdist upload -r local

Note: The prism currently has the most basic support for pypi's basic auth scheme. This mainly exists for the purpose of grabbing the identity of who puports to be uploading a package, rather than any actual security. If you need more, it should provide a starting point for extension (see pyramid documentation for more information on extending pyramid apps).

Install from your index

Now your package is available for install from your prism:

$ pip install -i http://mycheese/index/ MyAwesomePyPkg

All dependencies of MyAwesomePyPkg will also come from your prism, so make sure they are there (coming feature will inspect your release and do the needful).

Populate your index with your dependencies

There are 3 main ways to load files:

1. If you put archives into the file root of your index and restart the app, it will generate index entries for them. There are plans to make this automagical soon so a restart is not required.

2. Through the 'Load Requirements' page you may upload a pip requirements files that CheesePrism will use to populate your index. Easiest way to create a pip requirements file for a virtualenv?:

   $ pip freeze -l > myawesomerequirement.txt
   

3. Use the "Find Package" page to search pypi and load packages into the index. Currently this utilizes some state change on GET but does remain idempotent (to be fixed soon).

JSON API

There is also rudimentary read only json api:

$ curl GET http://mycheese/index/index.json

The resulting json is a hash of objects keyed by md5 hashes of each archive. Let's imagine our index only holds webob:

{u'1b6795baf23f6c1553186a0a8b1a2621':{u'added': 1325609450.792506,
                                      u'filename': u'WebOb-1.2b2.zip',
                                      u'name': u'WebOb',
                                      u'version': u'1.2b2'}}

HTTP API

Files may be added to the index from pypi via a not so RESTful interface that will soon go away. Provided name and version exist in PyPi, the following will download the file from pypi and register it with the index:

$ curl GET http://mycheese/package/{name}/{version}

Development Log

2012-01-09 whit <whit@surveymonkey.com>:

• Recursive download of requirements files and dependencies
• Search of pypi and download of files
• Improved test coverage
• Initialization of index on start up
• Basic read-only API for index
• Broader event support
• Documentation improvements

2011-12-21 whit <whit@surveymonkey.com>:

• Individual leaf update via event on upload
• Refactor to use pkginfo

2011-12-01 whit <whit@surveymonkey.com>:

• Housekeeping: add static fileserving for index for developments, more use of path.py
• Port over emporium readme.

2011-11-07 whit <whit@surveymonkey.com>:

• Get app basically serving

2011-11-07 whit <whit@surveymonkey.com>:

• Setup initial package structure