pypi-simple 0.3.0

PyPI Simple Repository API client library

GitHub | PyPI | Issues

pypi-simple is a client library for the Python Simple Repository API as specified in PEP 503. With it, you can query PyPI and other pip-compatible repositories for a list of their available projects and lists of each project’s available package files. The library also allows you to query package files for their project version, package type, file digests, requires_python string, and PGP signature URL.

Installation

Just use pip (You have pip, right?) to install pypi-simple and its dependencies:

pip install pypi-simple

Example

>>> from pypi_simple import PyPISimple
>>> client = PyPISimple()
>>> packages = client.get_project_files('requests')
>>> packages[0]
DistributionPackage(filename='requests-0.2.0.tar.gz', url='https://files.pythonhosted.org/packages/ba/bb/dfa0141a32d773c47e4dede1a617c59a23b74dd302e449cf85413fc96bc4/requests-0.2.0.tar.gz#sha256=813202ace4d9301a3c00740c700e012fb9f3f8c73ddcfe02ab558a8df6f175fd', project='requests', version='0.2.0', package_type='sdist', requires_python=None, has_sig=False)
>>> packages[0].filename
'requests-0.2.0.tar.gz'
>>> packages[0].url
'https://files.pythonhosted.org/packages/ba/bb/dfa0141a32d773c47e4dede1a617c59a23b74dd302e449cf85413fc96bc4/requests-0.2.0.tar.gz#sha256=813202ace4d9301a3c00740c700e012fb9f3f8c73ddcfe02ab558a8df6f175fd'
>>> packages[0].project
'requests'
>>> packages[0].version
'0.2.0'
>>> packages[0].package_type
'sdist'
>>> packages[0].get_digests()
{'sha256': '813202ace4d9301a3c00740c700e012fb9f3f8c73ddcfe02ab558a8df6f175fd'}

API

PyPISimple

A client for fetching package information from a Python simple package repository

PyPISimple(endpoint=pypi_simple.PYPI_SIMPLE_ENDPOINT)

Create a new PyPISimple object for querying the simple API instance at endpoint. The endpoint defaults to PyPI’s simple API at <https://pypi.org/simple/>.

client.get_projects()

Returns a generator of names of projects available in the repository. The names are not normalized.

Warning

PyPI’s project index file is very large and takes several seconds to parse. Use this method sparingly.

client.get_project_files(project)

Returns a list of DistributionPackage objects representing all of the package files available in the repository for the given project.

When fetching the project’s information from the repository, a 404 response is treated the same as an empty page, resulting in an empty list. All other HTTP errors cause a requests.HTTPError to be raised.

client.get_project_url(project)

Returns the URL for the given project’s page in the repository.

DistributionPackage

Information about a versioned archived file from which a Python project release can be installed. DistributionPackage objects have the following attributes and method:

filename

The basename of the package file

url

The URL from which the package file can be downloaded

project

The name of the project (as extracted from the filename), or None if the filename cannot be parsed

version

The project version (as extracted from the filename), or None if the filename cannot be parsed

package_type

The type of the package, or None if the filename cannot be parsed. The recognized package types are:

• 'dumb'

• 'egg'

• 'msi'

• 'rpm'

• 'sdist'

• 'wheel'

• 'wininst'

requires_python

An optional version specifier string declaring the Python version(s) in which the package can be installed

has_sig

Whether the package file is accompanied by a PGP signature file

sig_url

If has_sig is true, this equals the URL of the package file’s PGP signature file; otherwise, it equals None.

get_digests()

Extracts the hash digests from the package file’s URL and returns a dict mapping hash algorithm names to hex-encoded digest strings