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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: airflow-diagrams-2.0.0rc1.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.0rc1.tar.gz
Algorithm Hash digest
SHA256 7cdd09c54ceb708ebf7dabe30a1bf3ba42792e6bf90ab124b8cafcae20d1971e
MD5 906df920312e5fcd392adb615a7566a6
BLAKE2b-256 37410712494b4d36034ad98762c26026f7fca6ebe7e772dee772a6f1331212a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airflow_diagrams-2.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 f56858dec10b4687fb631fcea1313025603629a42a995b2427b2a5990373ad14
MD5 4ee4c604dbcbc2c621f1d62ce27152b0
BLAKE2b-256 6203a71884a17e409bbfead548b9d206e22d88b13ac9dbf69972f317e3659fb9

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