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",
        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.7.tar.gz (41.3 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.6.7-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: astronomer_cosmos-0.6.7.tar.gz
  • Upload date:
  • Size: 41.3 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.7.tar.gz
Algorithm Hash digest
SHA256 2b8cfdb9299a410b01248e6d766b9a55b3ba0abc789be745312ee4b7b2e6e108
MD5 5123bf5f9090bb6a2c742274b2d8f87b
BLAKE2b-256 e2b4f667a9365a174952ebad628a378249457d90c5e4d85e05d30225eb012297

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astronomer_cosmos-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 cb9ebe466e1452dc9013a07daa9435531fada50014afaae3648d6c1e04040195
MD5 cbcb57c9b7280425469cf63446aaa4da
BLAKE2b-256 ed3e7fef8a110dcd5cb3e2bc4678415c8cd90abfe38ae7e1d82dc3258d2205e7

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