Metadata-Version: 2.1
Name: airflow-diagrams
Version: 0.0.1
Summary: Auto-generated Diagrams from Airflow DAGs.
Home-page: https://github.com/feluelle/airflow-diagrams
Author: Felix Uellendall
Author-email: feluelle@pm.me
License: UNKNOWN
Description: # airflow-diagrams
        
        > Auto-generated Diagrams from Airflow DAGs.
        
        This project aims to easily visualise you [Airflow](https://github.com/apache/airflow) DAGs on service level 
        from providers like AWS, GCP, Azure, etc. via [diagrams](https://github.com/mingrammer/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):
        ```python
        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](examples/dags/test_dag.py).
        
        ## Contribute
        
        This project is in a very early stage. And contributions are welcome <3.
        The [mapping.json](airflow_diagrams/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
        
        [MIT](LICENSE)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
