Skip to main content

Render 3rd party workflows in Airflow

Project description

https://raw.githubusercontent.com/astronomer/astronomer-cosmos/main/docs/cosmos-logo.svg

fury ossrank downloads pre-commit.ci status

Run your dbt Core projects as Apache Airflow DAGs and Task Groups with a few lines of code. Benefits include:

  • Run dbt projects against Airflow connections instead of dbt profiles

  • Native support for installing and running dbt in a virtual environment to avoid dependency conflicts with Airflow

  • Run tests immediately after a model is done to catch issues early

  • Utilize Airflow’s data-aware scheduling to run models immediately after upstream ingestion

  • Turn each dbt model into a task/task group complete with retries, alerting, etc.

Quickstart

Check out the Quickstart guide on our docs.

Example Usage

You can render an Airflow Task Group 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="pre_dbt")

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

    e2 = EmptyOperator(task_id="post_dbt")

    e1 >> dbt_tg >> e2

This will generate an Airflow Task Group that looks like this:

https://raw.githubusercontent.com/astronomer/astronomer-cosmos/main/docs/jaffle_shop_task_group.png

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

Uploaded Source

Built Distribution

astronomer_cosmos-0.6.4-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

Details for the file astronomer_cosmos-0.6.4.tar.gz.

File metadata

  • Download URL: astronomer_cosmos-0.6.4.tar.gz
  • Upload date:
  • Size: 37.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for astronomer_cosmos-0.6.4.tar.gz
Algorithm Hash digest
SHA256 e4574b681f50a99b8952b0246b5dec24f8fe551ddff4c87bbe3918f5e24f7bbc
MD5 684b305b35c307c7c1b2515e8b9b797c
BLAKE2b-256 2d3e6cbc1c11614cb385d09354ce7f8b21873996c11a6e307d76f1d4787981a6

See more details on using hashes here.

File details

Details for the file astronomer_cosmos-0.6.4-py3-none-any.whl.

File metadata

File hashes

Hashes for astronomer_cosmos-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0f8f3a26e64285907843b011d8bce50eab2babaf88eceba1c9ce373e6cd2a688
MD5 1cc9ca6675546709bc40077aa9724267
BLAKE2b-256 5de1a552ae63233995b5415b20ad6546f108330b50ec8a8d4cead9f2066d7224

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