Commits

Martin von Löwis committed 5c374bc

Complete packaging.

Comments (0)

Files changed (3)

-include pep381run MANIFEST.in
+include pep381run processlogs MANIFEST.in
+This application implements a PyPI mirror application
+according to PEP 381.
+
+Installation
+------------
+
+It is possible to run this application directly from the source
+distribution. Alternatively, 'python setup.py 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>
+    ServerName X.pypi.python.org
+    CustomLog /var/log/apache2/pypi.log combined
+    DocumentRoot /var/pypi/web
+  </VirtualHost>
+
+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}
+
+Contact
+-------
+
+If you have questions or comments, please contact martin@v.loewis.de.
 setup(name='pep381client',
       version='1.0',
       description='Mirroring tool that implements the client (mirror) side of PEP 381',
-      author=u'Martin v. Löwis'.encode("utf-8"),
+      long_description=open('README').read(),
+      author='Martin v. Loewis',
       author_email='martin@v.loewis.de',
+      license = 'Academic Free License, version 3',
       url='http://bitbucket.org/loewis/pep381client/',
       packages=['pep381client'],
-      scripts=['pep381run']
+      scripts=['pep381run','processlogs']
      )