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
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
Built Distribution
File details
Details for the file airflow-diagrams-0.0.1.tar.gz
.
File metadata
- Download URL: airflow-diagrams-0.0.1.tar.gz
- Upload date:
- Size: 6.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0661565eb2dc4d7fb7c387bd05e1a4fc9a47107c054a2b2af4e4a352bf91a981 |
|
MD5 | 92c4b1a7e5725edc758406e27874fb76 |
|
BLAKE2b-256 | 5bc65c59ccba2fc0f153dd4b89ca68133ff948705f7e4c4a4c87be7675877821 |
File details
Details for the file airflow_diagrams-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: airflow_diagrams-0.0.1-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.7.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20a0ad8cfe193b97c5bc3475d1c917fc9438ba30a118b1e70f34c9da4b13296e |
|
MD5 | b9164f538b97eff19d474908e6e65e5a |
|
BLAKE2b-256 | 7bb4c1e520d382d0a29a02ac3882586405e6079a5db5aeb9aa202f9f0e4a678e |