Differences between revisions 5 and 7 (spanning 2 versions)
Revision 5 as of 2012-01-16 16:33:17
Size: 1036
Editor: ubershmekel
Comment: Both api's should be visible
Revision 7 as of 2013-03-22 08:44:40
Size: 1602
Editor: techtonik
Comment: proper capitalization
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from PyPiJson
Line 2: Line 4:
Line 5: Line 8:
  http://pypi.python.org/pypi/package_name/json
 .
 `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`

Line 8: Line 23:



Line 23: Line 42:
Line 24: Line 44:

Line 29: Line 51:


See the [[http://pypi.python.org/pypi/sphinxcontrib-cheeseshop|sphinxcontrib-cheeseshop project]] documentation for more information.

Note you can also use the XMLRPC api.

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.

PyPIJSON (last edited 2020-08-31 15:40:46 by JoshCooley)

Unable to edit the page? See the FrontPage for instructions.