Python data types for the Apache Kafka® Protocol.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for oss_aiven from gravatar.com oss_aiven

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

kio

CI Build Status Code coverage report
PyPI Package Python versions

Python data types for the Apache Kafka® Protocol.

Checkout the complete documentation →

Features

  • Exposes immutable dataclass entities for all protocol messages, generated from the same source as used internally in Apache Kafka®.
  • Message classes are simple light-weight data containers that do not inherit anything or expose any methods other than a regular dataclass. Encoding and decoding is enabled by making all the necessary details about Kafka encoding introspectable.
  • Widely compatible encoding and decoding of messages through the IO[bytes] interface.
  • Test suite with focus on roundtrip property tests using Hypothesis, including compatibility testing against the internals of upstream Apache Kafka®.

Installation

$ pip install --require-virtualenv kio

Development

Install development requirements.

$ pip install --require-virtualenv -e .[all]

The test suite contains integration tests that expects to be able to connect to an Apache Kafka® instance running on 127.0.0.1:9092. There is a Docker Compose file in container/compose.yml that you can use to conveniently start up an instance.

$ docker compose up -d kafka

Run tests.

$ python3 -X dev -m pytest --cov

Setup pre-commit to run on push.

$ pre-commit install -t pre-push

[!WARNING]
Building the schema will delete the src/kio/schema directory and recreate it again, hence all of the files under this directory will be deleted. Make sure to not put unrelated files there and accidentally wipe out your own work.

Fetch, generate, and format schema.

$ make build-schema

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for oss_aiven from gravatar.com oss_aiven

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.4.0

0.3.0

0.2.0

0.1.0

0.0.0a3 pre-release

0.0.0a2 pre-release

0.0.0a1 pre-release

0.0.0a0 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kio-0.4.0.tar.gz (144.8 kB view details)

Uploaded Source

Built Distribution

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

kio-0.4.0-py3-none-any.whl (722.6 kB view details)

Uploaded Python 3

File details

Details for the file kio-0.4.0.tar.gz.

File metadata

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

File hashes

Hashes for kio-0.4.0.tar.gz
Algorithm Hash digest
SHA256 939918fc0604ccea5e67b90de2648abc11d4bf670532a0f2084f673724038ade
MD5 1d3da59c741fe65d8cee25536de620fb
BLAKE2b-256 e8f058f85624014eb2eb44d47da146b171f67f1dafa81a0452a888ed71559805

See more details on using hashes here.

Provenance

The following attestation bundles were made for kio-0.4.0.tar.gz:

Publisher: release.yaml on Aiven-Open/kio

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

File details

Details for the file kio-0.4.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for kio-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9089b62a694fc4a25a7305aeeaf64450eaf0f96a35d7a0c040ef09e4b2f71087
MD5 8000eee775b333ea99db536ec4006132
BLAKE2b-256 346b88c5612acbf1d00ffc1559a06ffcdc590dfc5f23aa60c3e1dcbf9819c225

See more details on using hashes here.

Provenance

The following attestation bundles were made for kio-0.4.0-py3-none-any.whl:

Publisher: release.yaml on Aiven-Open/kio

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