Differences between revisions 8 and 48 (spanning 40 versions)
Revision 8 as of 2008-03-21 20:35:50
Size: 2448
Comment: Copy text from CheeseshopXmlRpc
Revision 48 as of 2018-07-10 16:43:27
Size: 348
Editor: EWDurbin
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= PyPI's XML-RPC methods = [[CheeseShopDev|PyPI]] APIs: [[PyPISimple|Simple]], [[PyPIJSON|JSON]], '''XMLRPC'''.
Line 3: Line 3:
Example usage:
{{{
>>> import xmlrpclib
>>> server = xmlrpclib.Server('http://pypi.python.org/pypi')
>>> server.package_releases('roundup')
['1.1.2']
>>> server.package_urls('roundup', '1.1.2')
[{'url':
'http://pypi.python.org/packages/source/r/roundup/roundup-1.1.2.tar.gz',
'packagetype': 'sdist'}, {'url':
'http://pypi.python.org/packages/any/r/roundup/roundup-1.1.2.win32.exe',
'packagetype': 'bdist_wininst'}]
}}}
= The XMLRPC interface for PyPI is considered legacy and should not be used. =
= Use the Simple and JSON APIs. =
For documentation on XMLRPC methods, see https://warehouse.readthedocs.io/api-reference/xml-rpc/
Line 17: Line 7:
'''list_packages()'''
  Retrieve a list of the package names registered with the package index. Returns a list of name strings.

'''package_releases(package name)'''
  Retrieve a list of the releases registered for the given package name. Returns a list of version strings.

'''release_urls(package_name, version)'''
  Retrieve a list of download URLs for the given package release. Returns a list of dicts {'url': the url, 'packagetype': the download package type} where the packagetype is one of the setup.py package types ('sdist', 'bdist', etc).

'''release_data(package_name, version)'''
  Retrieve metadata describing a specific package release. Returns a dict with keys for:

     * name
     * version
     * stable_version
     * author
     * author_email
     * maintainer
     * maintainer_email
     * home_page
     * license
     * summary
     * description
     * keywords
     * platform
     * download_url
     * classifiers (list of classifier strings)

'''search(spec[, operator])'''
   Search the package database using the indicated search spec.

 The spec may include any of the keywords described in the above list (except 'stable_version' and 'classifiers'), for example: {'description': 'spam'} will search description fields. Within the spec, a field's value can be a string or a list of strings (the values within the list are combined with an OR), for example: {'name': ['foo', 'bar']}.

 Arguments for different fields are combined using either "and" (the default) or "or". Example: search({'name': 'foo', 'description': 'bar'}, 'or').

 The results are returned as a list of dicts {'name': package name, 'version': package release version, 'summary': package release summary}

'''changelog(since)'''
  Retrieve a list of four-tuples (name, version, timestamp, action) since the given timestamp. All timestamps are UTC values. The argument is a UTC integer seconds since the epoch.

----
CategoryDocumentation
CategoryDocumentation CategoryDocumentation

PyPI APIs: Simple, JSON, XMLRPC.

The XMLRPC interface for PyPI is considered legacy and should not be used.

Use the Simple and JSON APIs.

For documentation on XMLRPC methods, see https://warehouse.readthedocs.io/api-reference/xml-rpc/

CategoryDocumentation CategoryDocumentation

PyPIXmlRpc (last edited 2018-07-10 16:43:27 by EWDurbin)

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