airflow-diagrams
Auto-generated Diagrams from Airflow DAGs.
This project aims to easily visualise your Airflow DAGs on service level from providers like AWS, GCP, Azure, etc. via diagrams.
đ Get started
To install it from PyPI run:
pip install airflow-diagrams
Then just call it like this:
Usage: airflow-diagrams generate [OPTIONS]
Generates <airflow-dag-id>_diagrams.py in <output-path> directory which
contains the definition to create a diagram. Run this file and you will get
a rendered diagram.
Options:
-d, --airflow-dag-id TEXT The dag id from which to generate the diagram.
By default it generates for all.
-h, --airflow-host TEXT The host of the airflow rest api from where to
retrieve the dag tasks information. [default:
http://localhost:8080/api/v1]
-u, --airflow-username TEXT The username of the airflow rest api.
[default: admin]
-p, --airflow-password TEXT The password of the airflow rest api.
[default: admin]
-o, --output-path DIRECTORY The path to output the diagrams to. [default:
.]
-m, --mapping-file FILE The mapping file to use for static mapping from
Airflow task to diagram node. By default no
mapping file is being used.
-v, --verbose Verbose output i.e. useful for debugging
purposes.
--help Show this message and exit.
Examples of generated diagrams can be found in the examples directory.
đ¤ How it Works
dag_id
) and all Tasks for the DAG(s).
mapping.yml
file to statically map from Airflow task to diagram node.
â¤ī¸ Contributing
Contributions are very welcome. Please go ahead and raise an issue if you have one or open a PR. Thank you.