PyPI Simple Repository API Client

Common errors

• ImportError: cannot import name 'PyPISimple' from 'pypi_simple'

  cause Typo in the import statement or trying to import from an incorrect module.
  fix Ensure the import path is exactly `from pypi_simple import PyPISimple`.

• AttributeError: 'NoneType' object has no attribute 'packages'

  cause The `get_project_page()` method returned `None`, indicating that the project name was not found or there was an issue fetching the page.
  fix Always check if the result of `get_project_page()` is `None` before attempting to access its attributes (e.g., `if project_page and project_page.packages:`).

• PyPISimple.exceptions.DigestMismatchError: Digest mismatch for ...

  cause The downloaded package file's digest (e.g., SHA256) does not match the one advertised by the repository, indicating possible corruption or tampering.
  fix This often points to a problem with the repository or download. You can try downloading again. If it persists, report it to the package maintainers or the repository. The exception object itself might contain `url` fields for more details.

Warnings

• deprecated The `DistributionPackage.provenance_sha256` attribute is deprecated and will always be `None`.
  Fix: Avoid relying on `provenance_sha256`. Use `provenance_url` if provenance information is needed.
• deprecated The `verify` argument in `PyPISimple.get_provenance()` is deprecated, and the method no longer verifies the provenance's digest.
  Fix: If provenance digest verification is critical, implement it separately after fetching the provenance data.
• breaking Support for Python 3.7 was dropped in version 1.6.0.
  Fix: Ensure your environment uses Python 3.8 or higher.
• gotcha Calling `PyPISimple.get_index_page()` (which returns a list of all projects) can be very slow due to the size of PyPI's index. PyPI's top-level simple HTML page is also cached for 24 hours.
  Fix: For specific project information, use `client.get_project_page('projectname')`. If you need to iterate through all projects, use `client.stream_project_names()` for better performance and memory management.

Install

• pip install pypi-simple Basic Installation
• pip install "pypi-simple[tqdm]" Installation with tqdm for progress bars

Imports

• PyPISimple

  from pypi_simple import PyPISimple

• tqdm_progress_factory

  from pypi_simple import PyPISimple, tqdm_progress_factory

  Required when installing with the 'tqdm' extra for progress bar integration.

Quickstart

This quickstart demonstrates how to fetch details for a specific project like 'requests' using `PyPISimple.get_project_page()`. It also includes a commented-out example for streaming all project names using `stream_project_names()`, with a caution about the size of PyPI's index.

from pypi_simple import PyPISimple

# Example 1: Get information about a package
with PyPISimple() as client:
    requests_page = client.get_project_page('requests')
    if requests_page and requests_page.packages:
        pkg = requests_page.packages[0]
        print(f"Latest 'requests' package: {pkg.filename} (version {pkg.version})")
        print(f"Download URL: {pkg.url}")

# Example 2: List all project names (caution: this can be slow and large)
# try:
#     with PyPISimple() as client:
#         # PyPI's top-level simple HTML page is cached for 24 hours.
#         # Use stream_project_names() for potentially faster, memory-efficient retrieval.
#         all_projects = list(client.stream_project_names())
#         print(f"Found {len(all_projects)} projects.")
# except Exception as e:
#     print(f"Error listing projects: {e}")