Auto-generated Diagrams from Airflow DAGs.
Project description
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.
Before | After |
---|---|
🚀 Get started
To install it from PyPI run:
pip install airflow-diagrams
NOTE: Make sure you have Graphviz installed.
Then just call it like this:
Examples of generated diagrams can be found in the examples directory.
🤔 How it Works
- ℹ️ It connects, by using the official Apache Airflow Python Client, to your Airflow installation to retrieve all DAGs (in case you don't specify any
dag_id
) and all Tasks for the DAG(s). - 🪄 It processes every DAG and its Tasks and 🔮 tries to find a diagram node for every DAGs task, by using Fuzzy String Matching, that matches the most. If you are unhappy about the match you can also provide a
mapping.yml
file to statically map from Airflow task to diagram node. - 🎨 It renders the results into a python file which can then be executed to retrieve the rendered diagram. 🎉
❤️ Contributing
Contributions are very welcome. Please go ahead and raise an issue if you have one or open a PR. Thank you.
Project details
Release history Release notifications | RSS feed
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-2.1.0.tar.gz
(14.8 kB
view hashes)
Built Distribution
Close
Hashes for airflow_diagrams-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 236243a5b3264f62e122151255f77152456c8bd477169495daf65f79cbcbdce4 |
|
MD5 | 41baec21ebf94da703da56fa23003f1b |
|
BLAKE2b-256 | 8b606e5ba4a3963bb6b60a704a536b5c68a11711d68e2d5f448bed505ec8b608 |