Size: 369
Comment:
|
Size: 1559
Comment: make nav header for PyPI API
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
PyPI API: '''JSON''', [[PyPIXmlRpc|XMLRPC]]. |
|
Line 3: | Line 6: |
http://pypi.python.org/pypi/package_name/json | |
Line 5: | Line 7: |
[[http://sphinx.pocoo.org/|Sphinx]] has support for putting an up-to-date Download link in your website using that JSON with one simple "[[https://bitbucket.org/birkenfeld/sphinx-contrib/src/26c8b46f3f3d/cheeseshop/|pypi-release]]" directive. | . `http://pypi.python.org/pypi/<package_name>/json` This retrieves information about the latest stable release (using [[http://www.python.org/dev/peps/pep-0386/|PEP 386]] ordering, falling back on older distutils ordering where packages are not PEP 386 compliant.) If you wish to retrieve information about a specific release you may use . `http://pypi.python.org/pypi/<package_name>/<version>/json` You can use this to automatically generate a link to the latest release of your package with (assuming use of jQuery): {{{ <span id="release_info" class="note">Download: <a href="http://pypi.python.org/pypi/roundup">latest</a></span> <script type="text/javascript"> $.getJSON('http://pypi.python.org/pypi/roundup/json?callback=?', function(data) { h = 'Download: ' + data.info.version; for (var i=0, url; url=data.urls[i]; ++i) { h += '<br><a href="' + url.url + '">' + url.filename + '</a>'; } $('#release_info').html(h); }); </script> }}} [[http://sphinx.pocoo.org/|Sphinx]] has support for putting an up-to-date Download link in your website using that JSON with one simple directive, for example (for the "roundup" package): {{{ .. pypi-release:: Roundup :prefix: Download :class: note }}} See the [[http://pypi.python.org/pypi/sphinxcontrib-cheeseshop|sphinxcontrib-cheeseshop project]] documentation for more information. |
PyPI API: JSON, XMLRPC.
You can access JSON information about packages by using the URL format
http://pypi.python.org/pypi/<package_name>/json
This retrieves information about the latest stable release (using PEP 386 ordering, falling back on older distutils ordering where packages are not PEP 386 compliant.) If you wish to retrieve information about a specific release you may use
http://pypi.python.org/pypi/<package_name>/<version>/json
You can use this to automatically generate a link to the latest release of your package with (assuming use of jQuery):
<span id="release_info" class="note">Download: <a href="http://pypi.python.org/pypi/roundup">latest</a></span> <script type="text/javascript"> $.getJSON('http://pypi.python.org/pypi/roundup/json?callback=?', function(data) { h = 'Download: ' + data.info.version; for (var i=0, url; url=data.urls[i]; ++i) { h += '<br><a href="' + url.url + '">' + url.filename + '</a>'; } $('#release_info').html(h); }); </script>
Sphinx has support for putting an up-to-date Download link in your website using that JSON with one simple directive, for example (for the "roundup" package):
.. pypi-release:: Roundup :prefix: Download :class: note
See the sphinxcontrib-cheeseshop project documentation for more information.