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.
  • High throughput: Bizon is designed to handle high throughput and can process billions of records.
  • Queue system agnostic: Bizon is agnostic of the queuing system, you can use any queuing system among Python Queue, RabbitMQ, Kafka or Redpanda. Thanks to the bizon.engine.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

List available sources and streams

bizon source list
bizon stream list <source_name>

Create a pipeline

Create a file named config.yml in your working directory with the following content:

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

destination:
  name: logger
  config:
    dummy: dummy

Run the pipeline with the following command:

bizon run config.yml

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.
  • rabbitmq: RabbitMQ, for production use and high throughput.
  • kafka: Apache Kafka, for production use and high throughput and strong persistence.

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.dev3.tar.gz (46.5 kB view details)

Uploaded Source

Built Distribution

bizon-0.0.4.dev3-py3-none-any.whl (77.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bizon-0.0.4.dev3.tar.gz
  • Upload date:
  • Size: 46.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.8.0-1014-azure

File hashes

Hashes for bizon-0.0.4.dev3.tar.gz
Algorithm Hash digest
SHA256 06673dabede31b63fc0533abab0284647013749768c5c0a9726ca9477f865afb
MD5 f69de4580a6340c4e82ce00507822ac8
BLAKE2b-256 dbb4d7ddcdcb1d88ffbb082380c187437bda9385c15e39c50daebbe0f109ee20

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bizon-0.0.4.dev3-py3-none-any.whl
  • Upload date:
  • Size: 77.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.8.0-1014-azure

File hashes

Hashes for bizon-0.0.4.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 ceb0562f8afcb5e580025b385d9510477dbe783bb0d93816292a00b6bcf71ba7
MD5 17d6a0435ba6d6e5bc899d7674888249
BLAKE2b-256 7da70d72990d3d917711f4cf4737c17a721be458b093198f1c5fdf048907acee

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