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.0rc1.tar.gz
(14.8 kB
view details)
Built Distribution
File details
Details for the file airflow-diagrams-2.1.0rc1.tar.gz
.
File metadata
- Download URL: airflow-diagrams-2.1.0rc1.tar.gz
- Upload date:
- Size: 14.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.14 CPython/3.9.13 Linux/5.13.0-1031-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63dc0e785df5428e7757240e534db9454a900bd571f1b1c689d7f26c414d8af8 |
|
MD5 | 8621780f487bc35e19149f05b741f1e4 |
|
BLAKE2b-256 | cd9df9863aa8ac9a3071bdb3543085f2bd11c57c7d282bbfb6bd275a9727153f |
File details
Details for the file airflow_diagrams-2.1.0rc1-py3-none-any.whl
.
File metadata
- Download URL: airflow_diagrams-2.1.0rc1-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.14 CPython/3.9.13 Linux/5.13.0-1031-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 196faaa985b8c8c546397c57b4de5df10b54ba5c90254460354741cca79b9d35 |
|
MD5 | 084c9357db89611f2af5a557be46e76d |
|
BLAKE2b-256 | 249d1b73b06f326e2f6845b603d5adc30671b323fdc204740f031def183fb779 |