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_interval="@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.2.1.tar.gz (47.4 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.2.1-py3-none-any.whl (70.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for astronomer_cosmos-1.2.1.tar.gz
Algorithm Hash digest
SHA256 f223ac8c33f23d96a44785ac0ef64d1115640be03fa6f26c3e7dfa8ed162e121
MD5 afa59e361c677617e4918478fe070a3b
BLAKE2b-256 7c6e5dd624dc838f5c562b61c446dbd89fec895c2e10b6d2f4ce87466987911e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astronomer_cosmos-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb9d20a392dea978f1e7c93fa09feb14c63e89c700ff5ee04cdb1b5cb568f7b3
MD5 dd75a333136e56804db69c8c1b31f622
BLAKE2b-256 4bacd48fbbe291c9bb921dd6f65f05ebce927ed6ceb23dcd45a193730b216cab

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