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.0.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

airflow_diagrams-2.0.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airflow-diagrams-2.0.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.10 Linux/5.11.0-1028-azure

File hashes

Hashes for airflow-diagrams-2.0.0.tar.gz
Algorithm Hash digest
SHA256 f73c24863619881706fb300982859579af0600838cc99f55dd1b86b5fffdc56e
MD5 4ec0ff8c6d7db1468688d89fd4539b0d
BLAKE2b-256 728c6551c5834bc829518a165eb836793053b7cd4d9add26fb8db3742fd901c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: airflow_diagrams-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.10 Linux/5.11.0-1028-azure

File hashes

Hashes for airflow_diagrams-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2010867f20c9ab473aa5e163607d63c12bd710d5f30af0d014157fb22ed90e34
MD5 a737f1248f6b043819c7944ebbabab2a
BLAKE2b-256 4d0bc274046c3a199abb012545080eff046cb133a71b42ad67be2079ac965777

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