Avro to Markdown
About The Project
Avro to markdown is a very simple project that generates readable markdown from an avro schema. This is useful to be able to generate readable, always up-to-date documentation on the schemas you use to exchange messages within your organization.
Getting Started
To get a local copy up and running follow these simple steps.
Installation
-
Clone the repo
git clone https://github.com/wayfair-incubator/avro-to-markdown.git
-
Install package
pip install avro-to-markdown
Usage
...
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Colm O'Connor
Project Link: https://github.com/wayfair-incubator/avro-to-markdown/
Acknowledgements
This template adapted from https://github.com/othneildrew/Best-README-Template
1 maintainer
Release files for avro-to-markdown 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| avro-to-markdown-0.2.0.tar.gz | 5.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| avro_to_markdown-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.6 kB
Release files / avro-to-markdown-0.2.0.tar.gz
| Download URL | avro-to-markdown-0.2.0.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f0dbaac892addab5162f7f68f30d30b9c8b4ecdf3227c66e79a653b0c16f34a
|
|
BLAKE2b-256 checksum How to use checksums |
e3973a484ff78685577a7120713efbeeba3170f212a0ac0c8cb559a082cb1630
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Release files / avro_to_markdown-0.2.0-py3-none-any.whl
| Download URL | avro_to_markdown-0.2.0-py3-none-any.whl |
|---|---|
| Size | 5.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb1748f46880ff19c494e7c873f33d783358973fb0eb1084884f37ef219aa013
|
|
BLAKE2b-256 checksum How to use checksums |
c1ca986532c6131c39aa75718881a3d878a51ebe8894e0fe5ceba15630356ec7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
