Skip to main content

Auto-generated Diagrams from Airflow DAGs.

Project description

airflow-diagrams

Auto-generated Diagrams from Airflow DAGs.

This project aims to easily visualise you Airflow DAGs on service level from providers like AWS, GCP, Azure, etc. via diagrams.

Installation

To install it from pypi run:

pip install airflow-diagrams

How-to-Use

To use this auto-generator just add the following two lines to your Airflow DAG (and run it):

from airflow_diagrams import generate_diagram_from_dag
generate_diagram_from_dag(dag=dag, diagram_file="diagram.py")

This will create a file called diagram.py which contains the definition to create a diagram.

Run this file and you will get a rendered diagram.

A working example can be found in examples.

Contribute

This project is in a very early stage. And contributions are welcome <3. The mapping.json needs a lot more entries so the Diagram can be proper created for all kinds of Airflow DAGs.

TODOs

  • Make installable via pip
  • Add more examples to README
  • Add more entries to mapping.json

License

MIT

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

airflow-diagrams-0.0.2.tar.gz (6.2 kB view hashes)

Uploaded Source

Built Distribution

airflow_diagrams-0.0.2-py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 3

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