pep381client / README

This application implements a PyPI mirror application
according to PEP 381.


It is possible to run this application directly from the source
distribution. Alternatively, 'python install' could be used.

The actual mirroring is performed by the pep381run script, which
should be invoked through cron like this::

   */15 *  *   *   *     /path/pep381client/pep381run -q /var/pypi

The command line arguments points to root of the data files that
the mirror creates. An initial run (without the -q option) should
be performed manually. It is possible to interrupt the mirroring;
it will automatically know where to continue when restarted.

In above example, /var/pypi/web must be served through the webserver.
An Apache configuration could read like this::

  <VirtualHost IPADDRESS:80>
    CustomLog /var/log/apache2/pypi.log combined
    DocumentRoot /var/pypi/web

To propagate the download statistics back to the central server,
processlogs must be run regularly, e.g. through::

   10 7  *   *   *     /path/pep381client/processlogs /var/pypi /var/log/apache2/pypi.log{,.1}


If you have questions or comments, please submit a bug report to, or contact me


1.3 (2010-07-06):

- The individual index pages where put into the wrong location; this is
  now fixed. Users should run 'mvindex /var/pypi' to fix their mirrors.

1.2 (2010-07-06):

- Fix #1 for good.

1.1 (2010-07-05):

- Issue #1: properly setup sqlite connection when initializing mirror.

1.0 (2010-07-05):

- Initial release