Commits

Martin von Löwis committed 40871e1

Add README.

Comments (0)

Files changed (2)

+PyPI SSH Access
+---------------
+
+For a long time, PyPI access required HTTP basic authentication with username and password.
+Even though OpenID is supported as well today, this cannot work for use in the distutils
+register and upload commands. In addition to these two methods, PyPI also supports
+authentication with an SSH key.
+
+To use this feature, upload your SSH key into the PyPI's 
+`Your Details <http://pypi.python.org/pypi?%3Aaction=user_form>`_ form. As distutils
+currently doesn't support using such a connection, this package performs heavy
+monkey-patching of distutils to make it use the system's ssh command. Users using
+this package should run ssh-agent (which runs automatically in the background on
+many systems) and load their PyPI key into the ssh agent.
+
+This release requires an "ssh" binary in the path. It has been tested only on Mac OS X.
+
+The source code and bug tracker for this package is available on 
+`Bitbucket <https://bitbucket.org/loewis/pypissh>`_.
             self.install_dir = os.path.join(sys.prefix, "lib", "site-packages")
 
 setup(name='pypissh',
-      version='1.0',
+      version='1.1',
       description='PyPI SSH Access',
+      long_description=open("README").read(),
       author='Martin v. Loewis',
       author_email='martin@v.loewis.de',
       url='http://pypi.python.org/pypi/pypissh',
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.