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.4.0.tar.gz (48.8 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.4.0-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vantage_python-0.4.0.tar.gz
  • Upload date:
  • Size: 48.8 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.4.0.tar.gz
Algorithm Hash digest
SHA256 77f4603b75ed33318641991fdf7f9a4853296e732ecee83ca1bf2b8fc4eb422f
MD5 d6d6b027f9a8c88be3f93c8ed090dfc1
BLAKE2b-256 4559e7ff176261821377ce25b3da0700b1af255f24b86c109b77a5e653bb3206

See more details on using hashes here.

Provenance

The following attestation bundles were made for vantage_python-0.4.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: vantage_python-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 40.6 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb3d8990ec99133c0108fdf99a3baefbf64bda6e5c262fde53e0f2ba10113ff2
MD5 6e4e80bb54c74e1f878339b24a081d7d
BLAKE2b-256 34d9435c950c69acaa9736ac12d18d2f7fa687b4e22052d43eabbd1a73016570

See more details on using hashes here.

Provenance

The following attestation bundles were made for vantage_python-0.4.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