Skip to main content

Python client for Vortex

Project description

Vortex Python Client

A Python client for sending data to the Vortex.

Overview

This client provides an easy way to send properly formatted messages to Kafka topics that will be consumed by the Vortex service and written to Iceberg tables.

The client:

  • Accepts arbitrary protobufs onto a buffer via log_proto
  • Flushes messages in a background thread so that log_proto calls do not block

Installation

Prerequisites

  • Python 3.11, 3.12, 3.13

Setup

# From the clients/python directory
uv sync --all-extras

Quick Start

from dbtlabs_vortex.producer import log_proto, shutdown

# Send JSON data
log_proto(... proto ...)

# Wait for all messages to be delivered
shutdown(timeout_seconds=0.500)

Examples

There is one example included in the examples/ directory. You can run it with:

uv run examples/send_batch.py

This will send some generated events to a locally running Vortex. It also serves as a reference implementation for how to log events to Vortex using existing protos.

Error Handling

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

dbtlabs_vortex-0.2.1.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

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

dbtlabs_vortex-0.2.1-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file dbtlabs_vortex-0.2.1.tar.gz.

File metadata

  • Download URL: dbtlabs_vortex-0.2.1.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dbtlabs_vortex-0.2.1.tar.gz
Algorithm Hash digest
SHA256 61f95e271f759b9f27046528af0a93fc775054f912da566bf645b67fd2a4c2c4
MD5 bec22dc72858b4c652562d289760c3be
BLAKE2b-256 9de373b8ccc1e74d8d7baa30fc8140d50c8b2346f12b64bb3870955f8f5c148d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbtlabs_vortex-0.2.1.tar.gz:

Publisher: release-python-client.yml on dbt-labs/vortex

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

File details

Details for the file dbtlabs_vortex-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: dbtlabs_vortex-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for dbtlabs_vortex-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 49de6314436fe87d98cc32f73f105b73502136c352626274dbd66c402c53b74a
MD5 27c3d1bb81636984bca86380e5b37384
BLAKE2b-256 6fca3b6b100514961277bc6b71835f7b0d52a07aa4df0235849f2f4e6e0cdc62

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbtlabs_vortex-0.2.1-py3-none-any.whl:

Publisher: release-python-client.yml on dbt-labs/vortex

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