Skip to main content

Async Python client library for the Valentina Noir API

Project description

Valentina Python Client

Async and sync Python client library for accessing the Valentina Noir API.

Features

  • Async and sync clients - Both VClient (async) and SyncVClient (sync) built on httpx
  • Type-safe - Full type hints with Pydantic models for request/response validation
  • Convenient factory pattern - Create a client once, access services from anywhere
  • Automatic pagination - Stream through large datasets with iter_all() or fetch everything with list_all()
  • Robust error handling - Specific exception types for different error conditions
  • Idempotency support - Optional automatic idempotency keys for safe retries
  • Rate limit handling - Built-in support for automatic rate limit retries

This client is a supported and up-to-date reference implementation for the Valentina Noir API.

Documentation

The full documentation is available at https://natelandau.github.io/valentina-python-client/.

Development Tools

Validate Constants

Verify that the Literal type constants in this package are in sync with the live API's /options endpoint. This catches drift between client and server before a release.

# Via duty task
uv run duty validate_constants

# Via script directly
uv run python scripts/validate_constants.py --api-key <key> --company-id <id>

The script reads configuration from (highest precedence first):

  1. CLI arguments (--api-url, --api-key, --company-id)
  2. System environment variables (VALENTINA_CLIENT_BASE_URL, VALENTINA_CLIENT_API_KEY, VALENTINA_CLIENT_DEFAULT_COMPANY_ID)
  3. A .env.secret file in the project root

Exit codes: 0 = all constants match, 1 = mismatches found, 2 = missing configuration.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

valentina_python_client-1.7.2.tar.gz (86.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

valentina_python_client-1.7.2-py3-none-any.whl (132.5 kB view details)

Uploaded Python 3

File details

Details for the file valentina_python_client-1.7.2.tar.gz.

File metadata

  • Download URL: valentina_python_client-1.7.2.tar.gz
  • Upload date:
  • Size: 86.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for valentina_python_client-1.7.2.tar.gz
Algorithm Hash digest
SHA256 1eeaf9c3adf358437094d6e7913d037bd9408bb2b24168818e0540829546147b
MD5 bbde17de4e805c50af483d067356dc72
BLAKE2b-256 d1f84cf9c3f1bbc2d103ca88e9f3042607a8f3e0ec5332bc2ab9a131d39632b2

See more details on using hashes here.

File details

Details for the file valentina_python_client-1.7.2-py3-none-any.whl.

File metadata

File hashes

Hashes for valentina_python_client-1.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 003de93d227e8058605da91976caf432afe672fbb9293c3ef87bf159d5bf240a
MD5 9eb57f09765883bce496ff971b9aeeea
BLAKE2b-256 ccf2e1fb21395b821654620edfa34c4a26ce101ab2041df17a5bf99a563f8246

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page