Skip to main content

Auto-generated Diagrams from Airflow DAGs.

Project description

airflow-diagrams

pre-commit.ci status test workflow codeql-analysis workflow codecov PyPI version License PyPI - Python Version PyPI version

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.

demo

Before After
dag diagram

🚀 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:

usage

Examples of generated diagrams can be found in the examples directory.

🤔 How it Works

  1. ℹ️ 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).
  2. 🪄 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.
  3. 🎨 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


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 details)

Uploaded Source

Built Distribution

airflow_diagrams-2.1.0-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file airflow-diagrams-2.1.0.tar.gz.

File metadata

  • Download URL: airflow-diagrams-2.1.0.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.15.0-1014-azure

File hashes

Hashes for airflow-diagrams-2.1.0.tar.gz
Algorithm Hash digest
SHA256 f94860129967b02660323cff2b6e110be18aeaa1d8240e5d94a76782b390a130
MD5 62bda917aa62a4168b420a4ca1097ad2
BLAKE2b-256 e7a6dedf48001991b0d0588dc7c55ac11650e1d0a3152a05e8601910b7e91620

See more details on using hashes here.

File details

Details for the file airflow_diagrams-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: airflow_diagrams-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.9.13 Linux/5.15.0-1014-azure

File hashes

Hashes for airflow_diagrams-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 236243a5b3264f62e122151255f77152456c8bd477169495daf65f79cbcbdce4
MD5 41baec21ebf94da703da56fa23003f1b
BLAKE2b-256 8b606e5ba4a3963bb6b60a704a536b5c68a11711d68e2d5f448bed505ec8b608

See more details on using hashes here.

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