Skip to main content

Thin HTTP client for the DRC Vantage platform API

Project description

drc-vantage

Thin HTTP client for the Vantage platform. Talks only to the Next.js API (VANTAGE_API_URL) with a global API key — never to Postgres or FastAPI directly.

Install

pip install drc-vantage
# or
uv add drc-vantage

Configuration

Variable Description Example
VANTAGE_API_URL Next.js API base (includes /api) http://localhost:3000/api
VANTAGE_API_KEY Global platform API key (same as server API_KEY) your_api_key
API_KEY Alias if VANTAGE_API_KEY is unset
VANTAGE_ORGANIZATION_ID Optional org scope (X-Organization-Id) org_xxx

Classes

Client, Dataset, DataSource, DataSourceCategory, DataStorageSystem

Dataset lifecycle example

from vantage import Client, Dataset

client = Client()  # VANTAGE_API_URL + VANTAGE_API_KEY

dataset = Dataset(
    client=client,
    location={"schema": "marts", "table": "customer_success_nps"},
    dataset_name="Customer Success NPS",
    dataset_type="TABLE",
    description="Qualtrics survey NPS summaries enriched with HubSpot contacts.",
    chat_question_examples={
        "en": ["What is the average NPS score by survey?"],
        "fr": ["Quel est le score NPS moyen par enquête?"],
    },
    data_source_slugs=["qualtrics", "hubspot"],
    storage_system_slug="postgresql",
    organization_slug="acme",
)

result = dataset.register_analyze_and_alert()
dataset.assign_to_team("customer-success", owner="owner@example.com")

Individual steps:

dataset.register()
dataset.run_validations()
dataset.analyze()
dataset.check_alerts()

Catalog register

from vantage import Client, DataSource, DataSourceCategory, DataStorageSystem

client = Client()

category = DataSourceCategory(
    client=client, slug="saas", name="SaaS", color="#3366FF", organization_slug="acme"
)
category.register()

source = DataSource(
    client=client,
    slug="hubspot",
    name="HubSpot",
    category=category,
    logo_url="https://example.com/hubspot.svg",
    organization_slug="acme",
)
source.register()

storage = DataStorageSystem(
    client=client,
    slug="postgresql",
    name="PostgreSQL",
    kind="POSTGRESQL",
    logo_url="https://example.com/pg.svg",
    organization_slug="acme",
)
storage.register()

Architecture

drc-vantage  →  Next.js (/api)  →  FastAPI  →  vantage-compute / Prefect

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

drc_vantage-2.0.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

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

drc_vantage-2.0.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file drc_vantage-2.0.1.tar.gz.

File metadata

  • Download URL: drc_vantage-2.0.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for drc_vantage-2.0.1.tar.gz
Algorithm Hash digest
SHA256 e66100400cf4bd93104d9a98a4af393ba7d6328a61656057ad466c46f8e8eda4
MD5 bf2dd7035b8fdb27c1c3ac05fb51d9e5
BLAKE2b-256 12ab648789e3633f801d0db274f72e947b95647d1b5538e78044b3be44b1ec61

See more details on using hashes here.

File details

Details for the file drc_vantage-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: drc_vantage-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for drc_vantage-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a7f0f77e7fb8230d98927d9a47cfa724a71db3215335fb91561ec54d139c7cff
MD5 4a5478895d7a227455adf9bf83a6df2d
BLAKE2b-256 47e7b9bb959b543452aba14b2a116e75cc778389df7d7f4be88c1b0fc6611eec

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