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.5.1.tar.gz (52.3 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.5.1-py3-none-any.whl (78.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: valentina_python_client-1.5.1.tar.gz
  • Upload date:
  • Size: 52.3 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.5.1.tar.gz
Algorithm Hash digest
SHA256 e4c1c48c39247ad31fc8706eb1af61fa95913892874cedc9bc707ecf5d13d953
MD5 dae51a23846c72b001cfbb6c3fb3f4d5
BLAKE2b-256 581cd2f573e2c45a2e7769d32941f6244b6ad06d1a0512466b2b44cda34ed2aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for valentina_python_client-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 836965a0d67190ce8e535cb0d5706d45da58499558508fa3821e32550e6bbb6c
MD5 635ac516f5b92e670df2303fe39d7ee5
BLAKE2b-256 335b8edbe050f3e665b032b6a5b027f8d01157ec8cc0a38e15b4531f32bdc9bd

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