devpi-api-client 0.2.0

High-level Python client for managing users, indexes, tokens, and packages on devpi servers.

Devpi API Client

Python client for automating user, index, token, and package management on a devpi server.

Installation

pip install devpi-api-client

To hack on the project locally:

pip install pipx
pipx install poetry
poetry install --with dev,docs

Quickstart

from devpi_api_client import Client

with Client("https://devpi.example.com", user="root", password="s3cret") as client:
    client.user.create("service", "changeme", email="[e-mail]")
    indexes = client.index.list("service")
    token = client.token.create("service", allowed=["upload"], expires_in_seconds=3600)

Logging

Enable debug logging to observe outgoing requests and error handling:

import logging

logging.basicConfig(level=logging.INFO)
logging.getLogger("devpi_api_client").setLevel(logging.DEBUG)

Documentation

Refer to docs/index.md for contributor and operator guides. Build the HTML docs locally:

poetry run mkdocs serve

Testing

poetry run pytest
poetry run ruff check .
poetry run mypy devpi_api_client

Release Process

1. Update CHANGELOG.md and bump the version with poetry version <patch|minor|major>.
2. Commit changes and push a tag like v0.2.0.
3. GitHub Actions builds and publishes to PyPI using the workflow described in docs/RELEASE_GUIDE.md.

License

MIT License. See LICENSE for full text.