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 fetches the latest OpenAPI schema from the Vantage API and generates Pydantic models, sync client, and async client. Your pip version will need to be up to date for this.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vantage_python-0.2.0.tar.gz
  • Upload date:
  • Size: 11.9 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.2.0.tar.gz
Algorithm Hash digest
SHA256 987583ae5de1dbc63cae0cd313f23fe61f7860620fd27bbed0f50096b351d90a
MD5 d71a9a5ad76cb6317b7c1df470c859fc
BLAKE2b-256 7e3542624506b9f6d981df38ea29c0185756079782180234bdcc35f8d2b070b9

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: vantage_python-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.1 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e02d6fde17cf129682f87d53c1744149f4dd2978bd1e9a959724d857ba546a9a
MD5 ce92206856f03d46dca869cd9df1caed
BLAKE2b-256 d0cd37c642b374655ef11bbd074aac1df1004cbf76c559bffb9db68df7f5f0e7

See more details on using hashes here.

Provenance

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