yarg: PyPI Client

0.1.10 · maintenance · verified Sat Apr 11

Yarg is a Python client library designed for programmatically querying the Python Package Index (PyPI). Built on top of the `requests` library, it offers a straightforward interface to retrieve package metadata, including release details, and interact with PyPI's RSS feeds for discovering new and recently updated packages. The current version, 0.1.10, was released in August 2024 primarily for Python 3.12 compatibility, indicating an infrequent release cadence focused on maintenance.

Warnings

gotcha PyPI package names are case-sensitive. `yarg.get()` will return a 404 Not Found error if the casing doesn't match the official PyPI registration.
Fix: Always use the exact case of the package name as registered on PyPI (e.g., `yarg.get('requests')` not `yarg.get('Requests')`).
deprecated The PyPI domain transitioned from `pypi.python.org` to `pypi.org`. While `yarg` might handle redirects, older clients or custom `pypi_server` configurations might encounter issues if they hardcode the old domain.
Fix: Ensure `yarg` is updated to the latest version (0.1.10) for best compatibility, and avoid hardcoding `pypi.python.org` in `pypi_server` arguments.
gotcha Older versions (pre-0.1.2) could raise `KeyError` if certain metadata fields like `home_page`, `bugtrack_url`, or `docs_url` were missing from PyPI's response for a package. This was fixed in 0.1.2.
Fix: Upgrade to `yarg` version 0.1.2 or newer to ensure robustness against missing metadata fields.
gotcha The `docs` attribute of a `Package` object is typically only populated for packages hosted on `pythonhosted.org`. Also, PyPI itself sometimes returns `docs_url` with an extra slash.
Fix: Be aware that `package.docs` might be empty for packages not on `pythonhosted.org`. Handle potential extra slashes in URLs if processing them programmatically.

Install

pip install yarg Install with pip

Imports

yarg
```
import yarg
```
The main entry point for all client functionality.
yarg.get
```
package = yarg.get('package_name')
```
yarg.newest_packages
```
new_packages = yarg.newest_packages()
```

yarg.latest_updated_packages

updated_packages = yarg.latest_updated_packages()

yarg.exceptions.HTTPError
```
from yarg.exceptions import HTTPError
```
Can also be accessed directly via `yarg.HTTPError` as of 0.1.1.

Quickstart

This quickstart demonstrates how to fetch a specific package's information using `yarg.get()` and how to retrieve a list of the newest packages published to PyPI using `yarg.newest_packages()`.

import yarg

try:
    package = yarg.get("requests")
    print(f"Package Name: {package.name}")
    print(f"Author: {package.author.name} ({package.author.email})")
    print(f"Latest Version: {package.latest_release.version}")
except yarg.exceptions.HTTPError as e:
    print(f"Error fetching package: {e}")

print("\n--- Newest Packages ---")
newest = yarg.newest_packages()
for p in newest[:3]:
    print(f"- {p.name} ({p.version})")

view raw JSON →