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 import DbtTaskGroup, ProfileConfig, ProjectConfig
from cosmos.profiles import PostgresUserPasswordProfileMapping

profile_config = ProfileConfig(
    profile_name="default",
    target_name="dev",
    profile_mapping=PostgresUserPasswordProfileMapping(
        conn_id="airflow_db",
        profile_args={"schema": "public"},
    ),
)

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

    dbt_tg = DbtTaskGroup(
        project_config=ProjectConfig("jaffle_shop"),
        profile_config=profile_config,
    )

    e2 = EmptyOperator(task_id="post_dbt")

    e1 >> dbt_tg >> e2

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

/docs/_static/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-1.1.0a1.tar.gz (42.1 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-1.1.0a1-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file astronomer_cosmos-1.1.0a1.tar.gz.

File metadata

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

File hashes

Hashes for astronomer_cosmos-1.1.0a1.tar.gz
Algorithm Hash digest
SHA256 e8e5631c824dd1452ca24131a5d7ebf9cd73de2f6a8f0634b8dd28c277b51e9d
MD5 0041dfdebcddf89f680aa43d5217e509
BLAKE2b-256 03e4ef72559f62c9152cf89a1cef61099c1a47f8cd104b58b555ab5e8cd5bd64

See more details on using hashes here.

File details

Details for the file astronomer_cosmos-1.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for astronomer_cosmos-1.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 5dd180adf8da7f6a85928dd246bb666a02eee1f9c2e046b39c4c0f8c3dd67f07
MD5 670d70af7bbab5b3d01b3bd332a5b4b4
BLAKE2b-256 03b7a63dd177a036b5a410e147cfd95b2b75bf208e3dfaa6d89656ddbeccc6a4

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