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

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: faust_avro_model_codegen-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 ca244b2d7051ae11fc54cf7c9a54982ea5f0eb3b26be8639d2a31b8ffffcbb1c
MD5 1fda1e7c7785d6ed3dab3f29cebe42e0
BLAKE2b-256 68e01ce7a34f22e2be3b7e35a6095d15c3657b6044109effffc7c13df0eef3d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for faust_avro_model_codegen-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 98bf699377a045226e085b60fd55b76bd947ec8b3507a887c7380ccb9f12eec8
MD5 fae19ab424b3dc6cdbf7fff24f0e6028
BLAKE2b-256 8762f4b70c5e5852cfee8c2be6e272853c8cab238ac4feababd93c297b03516b

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