Skip to main content

Async Python client library for the Valentina Noir API

Project description

Valentina Python Client

Async Python client library for accessing the Valentina Noir API.

Features

  • Async-first design - Built on httpx for efficient async HTTP operations
  • 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.6.1.tar.gz (52.6 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.6.1-py3-none-any.whl (78.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: valentina_python_client-1.6.1.tar.gz
  • Upload date:
  • Size: 52.6 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.6.1.tar.gz
Algorithm Hash digest
SHA256 514ea477237473a58afb2abea39c16620f7d32c45023ee491a52251a5140486b
MD5 c48e52c314a03802261bac50e0dfa265
BLAKE2b-256 6e65cdec1eb4a51959d6f09d07c10a8456cf8766546c6342801d1bf80c58502f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for valentina_python_client-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1bd84ce341297d68f1abab89176be7aba52f799b3f6a7c16ef92ad3bd300e1c9
MD5 49f208317b67e55b3a9e7fb0185e1032
BLAKE2b-256 a4828d69115459a635d2993a0b6808fc557d10c55bf8966c2bcc8277ff40bdd0

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