Skip to main content

Render 3rd party workflows in Airflow

Project description

https://github.com/astronomer/astronomer-cosmos/raw/main/docs/_static/banner.png

Astronomer Cosmos fury ossrank downloads pre-commit.ci status

A framework for dynamically generating Apache Airflow DAGs from other tools and frameworks. Develop your workflow in your tool of choice and render it in Airflow as a DAG or Task Group!

Current support for:
  • dbt

Coming soon:
  • Jupyter

  • Hex

  • And more…open an issue if you have a request!

Quickstart

Check out the Quickstart guide on our docs.

Example Usage (dbt)

Cosmos lets you render dbt projects as Airflow DAGs and Task Groups. To render a DAG, import DbtDag and point it to your dbt project.

from pendulum import datetime
from airflow import DAG
from cosmos.providers.dbt.dag import DbtDag

# dag for the project jaffle_shop
jaffle_shop = DbtDag(
    dbt_project_name="jaffle_shop",
    conn_id="airflow_db",
    dbt_args={
        "schema": "public",
    },
    dag_id="jaffle_shop",
    start_date=datetime(2022, 11, 27),
)

Simiarly, you can render an Airflow TaskGroups using the DbtTaskGroup class. Here’s an example with the jaffle_shop project:

from pendulum import datetime

from airflow import DAG
from airflow.operators.empty import EmptyOperator
from cosmos.providers.dbt.task_group import DbtTaskGroup


with DAG(
    dag_id="extract_dag",
    start_date=datetime(2022, 11, 27),
    schedule="@daily",
):

    e1 = EmptyOperator(task_id="ingestion_workflow")

    dbt_tg = DbtTaskGroup(
        group_id="dbt_tg",
        dbt_project_name="jaffle_shop",
        conn_id="airflow_db",
        dbt_args={
            "schema": "public",
        },
    )

    e2 = EmptyOperator(task_id="some_extraction")

    e1 >> dbt_tg >> e2

Changelog

We follow Semantic Versioning for releases. Check CHANGELOG.rst for the latest changes.

Contributing Guide

All contributions, bug reports, bug fixes, documentation improvements, enhancements are welcome.

A detailed overview an how to contribute can be found in the Contributing Guide.

As contributors and maintainers to this project, you are expected to abide by the Contributor Code of Conduct.

License

Apache License 2.0

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

astronomer_cosmos-0.5.1.dev0.tar.gz (22.1 kB view details)

Uploaded Source

File details

Details for the file astronomer_cosmos-0.5.1.dev0.tar.gz.

File metadata

  • Download URL: astronomer_cosmos-0.5.1.dev0.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for astronomer_cosmos-0.5.1.dev0.tar.gz
Algorithm Hash digest
SHA256 816dc6308f9ae27c094486bc565abd4370f3ac801ab3d4780fbcdfa1a490ab19
MD5 9bb89cfbf7ada6eb0c92e3363da05690
BLAKE2b-256 ac69a9f32323f11e6aafa08145f29ae7ac2ba69be3bc77dd542221c8e8864ba1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page