Skip to main content

Generate Faust Avro Models from Avro Schema files.

Project description

Faust Avro Code Generator

This is a Python library that generates Faust models from Avro schemas.

Installation

You can install the library using pip:

pip install faust_avro_code_gen

Configuration

You can configure the library for your application using either pyproject.toml or a standalone configuration file.

Using pyproject.toml

Add the following section to your pyproject.toml:

[tool.faust_avro_code_gen]
schema_dir = "path/to/your/schemas"
outfile = "path/to/your/models.py"
schema_registry_url = "http://localhost:8081"
faust_app_models_module = "models"

Using a standalone configuration file

Create a faust_avro_code_gen.toml file in your project root with the following content:

schema_dir = "path/to/your/schemas"
outfile = "path/to/your/models.py"
schema_registry_url = "http://localhost:8081"
faust_app_models_module = "models"

Usage

You can use the library from the command line as follows:

python -m faust_avro_code_gen 

If you have already registered your schemas with a Schema Registry, you can also verify that the schemas are correctly rendered by running the following command:

python -m faust_avro_code_gen --verify

This will generate Faust models from the Avro schemas in the directory specified in your configuration.

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

faust_avro_model_codegen-0.1.4.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file faust_avro_model_codegen-0.1.4.tar.gz.

File metadata

  • Download URL: faust_avro_model_codegen-0.1.4.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.13 Darwin/21.6.0

File hashes

Hashes for faust_avro_model_codegen-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ea98baa6fe3e4ea173d366c124ba2b59b3aea54b7a84fffd2d080ec027fed4a0
MD5 991ebb17ae7ca4037e4cc960ebd21fd6
BLAKE2b-256 ac95fcb68858afe742102f737301482fc0893038a8dfc055ea68bc3614b2b73e

See more details on using hashes here.

File details

Details for the file faust_avro_model_codegen-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for faust_avro_model_codegen-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 18163ad5c4145bc31abab61b6ac75d26ff5c299941a1318723472d02ef62a426
MD5 9314fcab387c33a869ff1d84155ba10c
BLAKE2b-256 d307a9f8528bb352738568f4fd779fc2ff47b991fad24c84dfd5e6f55c4289a6

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