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

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.0rc1.tar.gz (45.7 kB view details)

Uploaded Source

Built Distribution

astronomer_cosmos-0.7.0rc1-py3-none-any.whl (50.1 kB view details)

Uploaded Python 3

File details

Details for the file astronomer_cosmos-0.7.0rc1.tar.gz.

File metadata

  • Download URL: astronomer_cosmos-0.7.0rc1.tar.gz
  • Upload date:
  • Size: 45.7 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.7.0rc1.tar.gz
Algorithm Hash digest
SHA256 912ec16d2a02dd3401a9a6438fcfd406b5b2835898af3e95979f4b2d0842e545
MD5 137bd2944cb6f4882fce731fe8aa7154
BLAKE2b-256 5a2b010ca4d25ed9eebc5cd69e91babc13c14915f31b3747e520ab9f00ba89c3

See more details on using hashes here.

File details

Details for the file astronomer_cosmos-0.7.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for astronomer_cosmos-0.7.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 db6f6443925ec52bfd1f03a0f9d87d523374594265f2ef60f3e3b67eb42c16dd
MD5 bcc47301d656599d5d69f00c50cba058
BLAKE2b-256 da8c95fc79d6d430ae276cfac4430a291db4cdd6c829f3822b7a59c8d918a05a

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