Differences between revisions 7 and 8
Revision 7 as of 2006-09-26 08:32:14
Size: 1964
Editor: 85-125-62-180
Comment: store.query_packages() does not support 'stable_version' and 'classifiers'
Revision 8 as of 2007-07-13 19:43:18
Size: 2117
Comment: Add changelog operation
Deletions are marked like this. Additions are marked like this.
Line 21: Line 21:
  Retreive a list of the releases registered for the given package name. Returns a list of version strings.   Retrieve a list of the releases registered for the given package name. Returns a list of version strings.
Line 47: Line 47:

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

Cheese Shop XML-RPC Interface

Example usage:

>>> import xmlrpclib
>>> server = xmlrpclib.Server('http://cheeseshop.python.org/pypi')
>>> server.package_releases('roundup')
['1.1.2']
>>> server.package_urls('roundup', '1.1.2')
[{'url':
'http://cheeseshop.python.org/packages/source/r/roundup/roundup-1.1.2.tar.gz',
'packagetype': 'sdist'}, {'url':
'http://cheeseshop.python.org/packages/any/r/roundup/roundup-1.1.2.win32.exe',
'packagetype': 'bdist_wininst'}]

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, combined using either "and" (the default) or "or". 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. 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.

CheeseShopXmlRpc (last edited 2008-11-15 14:00:49 by localhost)

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