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.13.0.tar.gz (98.2 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.13.0-py3-none-any.whl (147.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: valentina_python_client-1.13.0.tar.gz
  • Upload date:
  • Size: 98.2 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.13.0.tar.gz
Algorithm Hash digest
SHA256 43bcd42d55661dd11b6d350c3d838928371263383e473c17dcce71ea940de090
MD5 69ac7476cedc5071b343c2d9d448363a
BLAKE2b-256 24d32f72b643e86ff299dfc4273f349cd6785efaf8d19ba0a6e06cc9f0ac1048

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for valentina_python_client-1.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4aa0c8ce7d45cf6f9057d8564caf13fbe255eb1870ca453735296e03be4cad1f
MD5 88da8baf13eec7c7ab15a4384bd29882
BLAKE2b-256 94071c0a44b4a44547c8b3e2e53e5c2f29805aabdc7a2507920101d464025852

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