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

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: faust_avro_model_codegen-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 ceafc9b0fbbd0b644c031514ea0a393d6d9f9ec0e760d1fa05006398c16119dc
MD5 588820cc6ae67525c803b863f26c3c15
BLAKE2b-256 26048ce3709fb59e0526828cdeaf5157dbd8ec06659b4bd30cc0ffb0d6008943

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for faust_avro_model_codegen-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f1a81b45e50a9ac2eff4045f3f9a199835c158829c82b388d8c239b46347d74d
MD5 06f2e2b7ae7909da382558f41c361c4b
BLAKE2b-256 bef6fc51102571a9a025f0ce326a17e1da1a4dcee4aa22e916739ead8ee354dd

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