Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting started guide with an example dbt project #778

Closed
wants to merge 3 commits into from
Closed

Update getting started guide with an example dbt project #778

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f231206
Update getting started guide with an example dbt project
RNHTTR Jan 2, 2024
c9e87d2
Update astro.rst
RNHTTR Jan 2, 2024
e7609a5
Merge branch 'main' into patch-3
tatiana Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/getting_started/astro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ To get started, you should have:

- The Astro CLI installed. You can find installation instructions `here <https://docs.astronomer.io/astro/cli/install-cli>`_.
- An Astro CLI project. You can initialize a new project with ``astro dev init``.
- A dbt project. The `jaffle shop example <https://github.com/dbt-labs/jaffle_shop>`_ is a great first step. To use the jaffle shop example to demo Cosmos...

- Clone the jaffle shop project using ``git clone`` into the ``/dags`` directory created by ``astro dev init``
- Add ``dbt-postgres`` to the requirements.txt file created by ``astro dev init``
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RNHTTR in this example, dbt is being installed in an independent Python virtual env, different from Airflow's Python deps.

Therefore, this dependency should be in the Create a virtualenv environment section, in the Dockerfile

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the goal of this getting started?

I didn't create it! I just found it. I'm likely in the minority for cosmos users, but I don't have dbt experience and I don't have a dbt project laying around, so the motivation for this change was to include a sample dbt project. @jlaneve 's cosmos-demo works nicely -- I hadn't seen that before. I think the docs should link to that though maybe?

The current "quickstart" link just goes to the cosmos docs



Create a virtual environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading