https://github.com/jpmorganchase/py-avro-schema
Generate Apache Avro schemas for Python types including standard library data-classes and Pydantic data models.
https://github.com/jpmorganchase/py-avro-schema
avro data dataclasses deserialization generate jpmorganchase kafka messaging pydantic python schema serialization types
Last synced: 3 months ago
JSON representation
Generate Apache Avro schemas for Python types including standard library data-classes and Pydantic data models.
- Host: GitHub
- URL: https://github.com/jpmorganchase/py-avro-schema
- Owner: jpmorganchase
- License: apache-2.0
- Created: 2022-03-09T21:50:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T11:47:37.000Z (about 1 year ago)
- Last Synced: 2025-06-12T04:21:55.041Z (4 months ago)
- Topics: avro, data, dataclasses, deserialization, generate, jpmorganchase, kafka, messaging, pydantic, python, schema, serialization, types
- Language: Python
- Homepage: https://py-avro-schema.readthedocs.io/
- Size: 234 KB
- Stars: 42
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-avro-schema
Generate [Apache Avro][] schemas for Python types including standard library [data-classes][] and [Pydantic data models][].
:blue_book: Documentation: https://py-avro-schema.readthedocs.io
## Installing
```shell
python -m pip install py-avro-schema
```
## Developing
To setup a scratch/development virtual environment (under `.venv/`), first install [Tox][].
Then run:
```shell
tox -e dev
```
The `py-avro-schema` package is installed in [editable mode][] inside the `.venv/` environment.
Run tests by simply calling `tox`.
Install code quality Git hooks using `pre-commit install --install-hooks`.
## Terms & Conditions
Copyright 2022 J.P. Morgan Chase & Co.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
## Contributing
See [CONTRIBUTING.md][]
[Apache Avro]: https://avro.apache.org
[data-classes]: https://docs.python.org/3/library/dataclasses.html
[Pydantic data models]: https://docs.pydantic.dev/usage/models
[Tox]: https://tox.wiki
[editable mode]: https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e
[CONTRIBUTING.md]: https://github.com/jpmorganchase/.github/blob/main/CONTRIBUTING.md