Skip to main content

Avro to Markdown

CI pipeline status Contributor Covenant

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

  1. Clone the repo

    git clone https://github.com/wayfair-incubator/avro-to-markdown.git
    
  2. 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

Metadata

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)

Source distribution for avro-to-markdown 0.2.0
File Size Uploaded Provenance Actions
avro-to-markdown-0.2.0.tar.gz 5.1 kB Without provenance Details for avro-to-markdown-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for avro-to-markdown 0.2.0
File Interpreter ABI Platform Actions
avro_to_markdown-0.2.0-py3-none-any.whl Python 3 none any Details for avro_to_markdown-0.2.0-py3-none-any.whl

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

Security for avro-to-markdown 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page