Skip to main content

Python SDK for the Vantage API

Project description

vantage-python

A Python SDK for the Vantage API. Types and client methods are auto-generated from the official OpenAPI specification.

Installation

pip install vantage-python

Usage

Synchronous Client

from vantage import Client

client = Client("your-api-token")

# List resources with query parameters
reports = client.cost_reports.list(page=1)

# Get a specific resource by token
report = client.cost_reports.get("rprt_abc123")

# Create a new resource
folder = client.folders.create(CreateFolder(
    title="Production Costs",
    workspace_token="wrkspc_123",
))

# Update a resource
client.folders.update("fldr_abc123", UpdateFolder(
    title="Updated Title",
))

# Delete a resource
client.folders.delete("fldr_abc123")

Async Client

from vantage import AsyncClient

async with AsyncClient("your-api-token") as client:
    folders = await client.folders.list()

    folder = await client.folders.create(CreateFolder(
        title="Production Costs",
        workspace_token="wrkspc_123",
    ))

Error Handling

API errors are raised as VantageAPIError with structured error information:

from vantage import Client, VantageAPIError

try:
    client.cost_reports.get("invalid_token")
except VantageAPIError as e:
    print(e.status)      # 404
    print(e.status_text)  # "Not Found"
    print(e.errors)       # ["Resource not found"] or None

Development

Building

make install

This generates Pydantic models, sync client, and the async client. Your pip version will need to be up to date for this. If you wish to generate the client first, you should use make generate.

Testing

pytest

Publishing

make publish

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

vantage_python-0.3.0.tar.gz (44.4 kB view details)

Uploaded Source

Built Distribution

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

vantage_python-0.3.0-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file vantage_python-0.3.0.tar.gz.

File metadata

  • Download URL: vantage_python-0.3.0.tar.gz
  • Upload date:
  • Size: 44.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vantage_python-0.3.0.tar.gz
Algorithm Hash digest
SHA256 09190f86226a3db311d8eab02167b130f8a6b4fc7f808a603b7b3a876013c468
MD5 d4a255fb80fc40ce04a2f17148f59c6c
BLAKE2b-256 b5c9be468614ee0afd8f1e04a0f490a4b6cf461354332fbd6d5a91b6ddb649c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for vantage_python-0.3.0.tar.gz:

Publisher: pypi-publish.yml on vantage-sh/vantage-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vantage_python-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: vantage_python-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 38.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vantage_python-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0aa09cf4b1ceb90a37e0b74cd6426e7862cc9558201784c47782591e915ee74c
MD5 5bdf560ce9dafd8fa004875817d8f884
BLAKE2b-256 af2a752f5507bd9c33d5a54212429084cf0e1fd55f7a704b3bbd8d277b06f4ef

See more details on using hashes here.

Provenance

The following attestation bundles were made for vantage_python-0.3.0-py3-none-any.whl:

Publisher: pypi-publish.yml on vantage-sh/vantage-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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