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.

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

Create a Python virtual environment #6681

Merged
merged 29 commits into from
Jan 27, 2025
Merged

Create a Python virtual environment #6681

merged 29 commits into from
Jan 27, 2025

Conversation

nataliefiann
Copy link
Contributor

@nataliefiann nataliefiann commented Dec 17, 2024

What are you changing in this pull request and why?

I have created this PR following this Git issue: #2143 to guide users on how to create a Python virtual environment

Closes: #2143

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

@nataliefiann nataliefiann requested a review from a team as a code owner December 17, 2024 14:16
Copy link

vercel bot commented Dec 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Jan 27, 2025 10:31am

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address labels Dec 17, 2024
website/sidebars.js Outdated Show resolved Hide resolved
@nataliefiann
Copy link
Contributor Author

Querying the .venv folder as out docs don't ref it: https://dbt-labs.slack.com/archives/C05FWBP9X1U/p1734723735789049

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

thanks @nataliefiann , approved and have a sugg to make the headers flow better since the other sections related to actual installation are nested under the 'python env' header. and the prereqs are for the entire page/

sug something like this:



# Install with pip
....
## Using virtual environments
...
### Prerequisites
....

### 1. Create a virtual environment

### 2. Activate the virtual environment
....

### 3. Deactivate the virtual environment (optional)
....

### 4. Create an alias (optional)

## Install dbt Core and adapters
...

### 1. Install dbt Core and an adapter
...

### 2. Upgrade adapters
...

### 3. Install dbt Core only
....

## Change dbt Core versions
....
## pip install dbt
....
## Install prereleases
....

@@ -119,7 +193,7 @@ If you're building a tool that integrates with dbt Core, you may want to install
python -m pip install dbt-core
```

### Change dbt Core versions
## Change dbt Core versions
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.SentenceCaseHeaders] 'Change dbt Core versions' should use sentence-style capitalization. Try 'Change dbt core versions' instead.

Base automatically changed from nfiann-prerelease to current January 27, 2025 10:25
@nataliefiann nataliefiann merged commit 75ef42b into current Jan 27, 2025
8 checks passed
@nataliefiann nataliefiann deleted the new-branch-name-VE branch January 27, 2025 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants