Skip to main content

Extract and load your data reliably from API Clients with native fault-tolerant and checkpointing mechanism.

Project description

bizon ⚡️

Extract and load your largest data streams with a framework you can trust for billion records.

Features

  • Natively fault-tolerant: Bizon uses a checkpointing mechanism to keep track of the progress and recover from the last checkpoint.
  • Queue system agnostic: Bizon is agnostic of the queuing system, you can use any queuing system like Python Queue, Kafka or Redpanda. Thanks to the bizon.queue.Queue interface, adapters can be written for any queuing system.
  • Pipeline metrics: Bizon provides exhaustive pipeline metrics and implement OpenTelemetry for tracing. You can monitor:
    • ETAs for completion
    • Number of records processed
    • Completion percentage
    • Latency Source <> Destination
  • Lightweight & lean: Bizon is lightweight, minimal codebase and only uses few dependencies:
    • requests for HTTP requests
    • pyyaml for configuration
    • sqlalchemy for database / warehouse connections
    • pyarrow for Parquet file format

Installation

pip install bizon

Usage

from yaml import safe_load
from bizon.engine.runner import RunnerFactory

yaml_config = """
source:
  source_name: dummy
  stream_name: creatures
  authentication:
    type: api_key
    params:
      token: dummy_key

destination:
  name: logger
  config:
    dummy: dummy
"""

config = safe_load(yaml_config)
runner = RunnerFactory.create_from_config_dict(config=config)
runner.run()

Backend configuration

Backend is the interface used by Bizon to store its state. It can be configured in the backend section of the configuration file. The following backends are supported:

  • sqlite: In-memory SQLite database, useful for testing and development.
  • biguquery: Google BigQuery backend, perfect for light setup & production.
  • postgres: PostgreSQL backend, for production use and frequent cursor updates.

Queue configuration

Queue is the interface used by Bizon to exchange data between Source and Destination. It can be configured in the queue section of the configuration file. The following queues are supported:

  • python_queue: Python Queue, useful for testing and development.
  • kafka: Apache Kafka, for production use and high throughput.

Start syncing your data 🚀

Quick setup without any dependencies ✌️

Queue configuration can be set to python_queue and backend configuration to sqlite. This will allow you to test the pipeline without any external dependencies.

Local Kafka setup

To test the pipeline with Kafka, you can use docker compose to setup Kafka or Redpanda locally.

Kafka

docker compose --file ./scripts/kafka-compose.yml up # Kafka
docker compose --file ./scripts/redpanda-compose.yml up # Redpanda

In your YAML configuration, set the queue configuration to Kafka under engine:

engine:
  queue:
    type: kafka
    config:
      queue: bootstrap_server: localhost:9092 # Kafka:9092 & Redpanda: 19092

RabbitMQ

docker compose --file ./scripts/rabbitmq-compose.yml up

In your YAML configuration, set the queue configuration to Kafka under engine:

engine:
  queue:
    type: rabbitmq
    config:
      queue:
        host: localhost
        queue_name: bizon

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

bizon-0.0.4.dev1.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

bizon-0.0.4.dev1-py3-none-any.whl (71.1 kB view details)

Uploaded Python 3

File details

Details for the file bizon-0.0.4.dev1.tar.gz.

File metadata

  • Download URL: bizon-0.0.4.dev1.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.9 Darwin/23.6.0

File hashes

Hashes for bizon-0.0.4.dev1.tar.gz
Algorithm Hash digest
SHA256 27ffacd2864be87c8002f262e192e1852234589853bd84dab35913fa5df68f44
MD5 7ccc43423195376ce780018c2e01209b
BLAKE2b-256 e98c76a2f30c1e32c3c7c91c6e2eddf8d460f4d890c29a205430c3ce10d64852

See more details on using hashes here.

File details

Details for the file bizon-0.0.4.dev1-py3-none-any.whl.

File metadata

  • Download URL: bizon-0.0.4.dev1-py3-none-any.whl
  • Upload date:
  • Size: 71.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.9 Darwin/23.6.0

File hashes

Hashes for bizon-0.0.4.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 97688fc25dba7102d94e0ad34a2a8bbe6d1c9c46b8398ef191b4b16511bad4bf
MD5 7e0296665b49ebc031bbc15e063a763e
BLAKE2b-256 b7383bfcd6abfac7740090b09ee80bc263b0b23c85168aaf1bee7c96ef45f44a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page