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

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: faust_avro_model_codegen-0.1.5.tar.gz
  • Upload date:
  • Size: 7.4 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.5.tar.gz
Algorithm Hash digest
SHA256 6d907e1fed4d460aa5e707fa8e3a994062878ca40152e0a472c0668c8eed154f
MD5 f72d5b424fc3371bf2251f030c182ddc
BLAKE2b-256 48880d6790cd278ec76124cd3a25c101ad99728229c812b035189e08297d0907

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for faust_avro_model_codegen-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 02d4fb96d0e59a78aa3581484f66d25fc9383470e78d67579a630aa2963058a5
MD5 f7b01f2d689b144358afd47ce76fe396
BLAKE2b-256 206ab8ebbfd624b6f12a63c1484e92d5455cd00466c61a00dde8693711603594

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