Skip to main content

Render 3rd party workflows in Airflow

Project description

https://raw.githubusercontent.com/astronomer/astronomer-cosmos/main/docs/_static/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",
        profile_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

Community

  • Join us on the Airflow Slack at #airflow-dbt

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

astronomer_cosmos-0.7.4-py3-none-any.whl (51.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for astronomer_cosmos-0.7.4.tar.gz
Algorithm Hash digest
SHA256 c212e1ed1cbd2d93f9f7c5aa92bcb553e9406f2f46d0029afb68e40e51125225
MD5 4e23e688c058f1730fe0d09330ee30f2
BLAKE2b-256 41ac366f16bc675de36a09298ca771d3757261dc3ca23899c68f15a581b53780

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astronomer_cosmos-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 37b82feb7fb607e783e5d774bd8af23458bf736cd1e826d08f3c23532b673788
MD5 e882232ff6ed77277a051511e54b48af
BLAKE2b-256 8007832c7feac921aa9189260441c016bdfa21dad4ab18e1f78a0647cd1fb955

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