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.2.0a1.tar.gz (45.8 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.0a1-py3-none-any.whl (68.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: astronomer_cosmos-1.2.0a1.tar.gz
  • Upload date:
  • Size: 45.8 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.0a1.tar.gz
Algorithm Hash digest
SHA256 e3aaa0b1b82bbaff6b5c6b9ca25c1bed3f13d90f594b535c0f8158a4c13f8264
MD5 6df929a3397f92fbb5c3d9a617a8420f
BLAKE2b-256 7acf201ab96badd3d7878a32928e76612dd587f5d516b30470537501cffd0c7d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for astronomer_cosmos-1.2.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 dda508c27feaa132096ad9e02ba7d7e457d6198b0423a16653f97953aa5b5a32
MD5 a1561227e22439ce6175e5e21c55e0df
BLAKE2b-256 e363f810fc53d1080a3937461c8230b1ccc56ecfefd87d470afe9024d321a476

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