astronomer-cosmos
Release 1.5.0rc2

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 Getting Started guide on our docs. See more examples at /dev/dags and at the cosmos-demo repo.

Example Usage

You can render a Cosmos Airflow DAG using the DbtDag class. Here's an example with the jaffle_shop project:

astronomer-cosmos/dev/dags/basic_cosmos_dag.py

Lines 1 to 42 in 24aa38e

    
           """ 
        
           An example DAG that uses Cosmos to render a dbt project. 
        
           """ 
        
           import os 
        
           from datetime import datetime 
        
           from pathlib import Path 
        
           from cosmos import DbtDag, ProjectConfig, ProfileConfig 
        
           from cosmos.profiles import PostgresUserPasswordProfileMapping 
        
           DEFAULT_DBT_ROOT_PATH = Path(__file__).parent / "dbt" 
        
           DBT_ROOT_PATH = Path(os.getenv("DBT_ROOT_PATH", DEFAULT_DBT_ROOT_PATH)) 
        
           profile_config = ProfileConfig( 
        
               profile_name="default", 
        
               target_name="dev", 
        
               profile_mapping=PostgresUserPasswordProfileMapping( 
        
                   conn_id="airflow_db", 
        
                   profile_args={"schema": "public"}, 
        
               ), 
        
           ) 
        
           # [START local_example] 
        
           basic_cosmos_dag = DbtDag( 
        
               # dbt/cosmos-specific parameters 
        
               project_config=ProjectConfig( 
        
                   DBT_ROOT_PATH / "jaffle_shop", 
        
               ), 
        
               profile_config=profile_config, 
        
               operator_args={ 
        
                   "install_deps": True,  # install any necessary dependencies before running any dbt command 
        
                   "full_refresh": True,  # used only in dbt commands that support this flag 
        
               }, 
        
               # normal dag parameters 
        
               schedule_interval="@daily", 
        
               start_date=datetime(2023, 1, 1), 
        
               catchup=False, 
        
               dag_id="basic_cosmos_dag", 
        
               default_args={"retries": 2}, 
        
           ) 
        
           # [END local_example]

This will generate an Airflow DAG that looks like this:

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

Privacy Notice

The application and this website collect telemetry to support the project's development. These can be disabled by the end-users.

Read the Privacy Notice to learn more about it.

https://static.scarf.sh/a.png?x-pxid=ae43a92a-5a21-4c77-af8b-99c2242adf93

Security Policy

Check the project's Security Policy to learn how to report security vulnerabilities in Astronomer Cosmos and how security issues reported to the Astronomer Cosmos security team are handled.

astronomer-cosmos
Release 1.5.0rc2

Release 1.5.0rc2

0.6.3

0.12.0

1.8.0

1.8.0a5

1.8.0a4

1.8.0a3

1.8.0a2

1.8.0a1

1.5.0rc2

1.7.1

Documentation

Quickstart

Example Usage

Community

Changelog

Contributing Guide

License

Privacy Notice

Security Policy

Stats

Development practices

Releases

Contributors

	"""
	An example DAG that uses Cosmos to render a dbt project.
	"""

	import os
	from datetime import datetime
	from pathlib import Path

	from cosmos import DbtDag, ProjectConfig, ProfileConfig
	from cosmos.profiles import PostgresUserPasswordProfileMapping

	DEFAULT_DBT_ROOT_PATH = Path(__file__).parent / "dbt"
	DBT_ROOT_PATH = Path(os.getenv("DBT_ROOT_PATH", DEFAULT_DBT_ROOT_PATH))

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

	# [START local_example]
	basic_cosmos_dag = DbtDag(
	# dbt/cosmos-specific parameters
	project_config=ProjectConfig(
	DBT_ROOT_PATH / "jaffle_shop",
	),
	profile_config=profile_config,
	operator_args={
	"install_deps": True, # install any necessary dependencies before running any dbt command
	"full_refresh": True, # used only in dbt commands that support this flag
	},
	# normal dag parameters
	schedule_interval="@daily",
	start_date=datetime(2023, 1, 1),
	catchup=False,
	dag_id="basic_cosmos_dag",
	default_args={"retries": 2},
	)
	# [END local_example]

astronomer-cosmos Release 1.5.0rc2

Release 1.5.0rc2 Toggle Dropdown 0.6.3 0.12.0 1.8.0 1.8.0a5 1.8.0a4 1.8.0a3 1.8.0a2 1.8.0a1 1.5.0rc2 1.7.1

Documentation

Quickstart

Example Usage

Community

Changelog

Contributing Guide

License

Privacy Notice

Security Policy

Stats

Development practices

Releases

Contributors

astronomer-cosmos
Release 1.5.0rc2

Release 1.5.0rc2

0.6.3

0.12.0

1.8.0

1.8.0a5

1.8.0a4

1.8.0a3

1.8.0a2

1.8.0a1

1.5.0rc2

1.7.1