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.0.tar.gz (13.0 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.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbtlabs_vortex-0.2.0.tar.gz
  • Upload date:
  • Size: 13.0 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.0.tar.gz
Algorithm Hash digest
SHA256 44cf955d7a9dbad045888d123250c00dce266e7b8bee24f0e106f5cf866dc950
MD5 6cea6c0183ede4570e4e11195ab931da
BLAKE2b-256 8faa7c7c307ac3125d3541263f0a14e147de5eb307487774db9e81fb9bfcf3bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbtlabs_vortex-0.2.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: dbtlabs_vortex-0.2.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c5314d39cbc3d354bd55f49db6977face3da63ce7e2cdd13eb9facbfb0f0f61
MD5 f7eb08bb14458a503600ff6a89d8acb6
BLAKE2b-256 45054abb2a2826fce9610a6225a00770cce5bb3fe4b5e0fb10e158f17a312776

See more details on using hashes here.

Provenance

The following attestation bundles were made for dbtlabs_vortex-0.2.0-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