Skip to content

AbsaOSS/py2k

Repository files navigation

Welcome to Py2k

Tests codecov pypi downloads versions license

A high level Python to Kafka API with Schema Registry compatibility and automatic avro schema creation.

  • Free software: Apache2 license

Installation

Py2K is currently available on PIP:

pip install py2k

Documentation

You can view additional documentation on our website.

Contributing

Please see the Contribution Guide for more information.

Usage

Minimal Example

from py2k.record import PandasToRecordsTransformer
from py2k.writer import KafkaWriter

# assuming we have a pandas DataFrame, df
records = PandasToRecordsTransformer(df=df, record_name='test_model').from_pandas()

writer = KafkaWriter(
    topic="topic_name",
    schema_registry_config=schema_registry_config,
    producer_config=producer_config
)

writer.write(records)

For additional examples please see the examples folder

Features

  • Schema Registry Integration
  • Automatic Avro Serialization from pandas DataFrames
  • Automatic Avro Schema generation from pandas DataFrames and Pydantic objects

License

Copyright 2021 ABSA Group Limited

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.