-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Avoid unnecessary pyenv usage in environment setup #26088
Closed
+16
−29
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,28 +9,20 @@ We love to see our community members get involved! If you are planning to contri | |
|
||
## Environment setup | ||
|
||
1. Install a version of Python that Dagster supports. <DagsterVersion /> | ||
|
||
2. Create and activate a virtualenv, using the tool of your choice. On macOS you can install `pyenv` with Homebrew: | ||
1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/). On macOS, you can install use `curl` to download the script and execute it with `sh`: | ||
|
||
```bash | ||
brew install pyenv pyenv-virtualenv | ||
curl -LsSf https://astral.sh/uv/install.sh | sh | ||
``` | ||
|
||
Then add the following commands to your shell profile: | ||
2. Create and activate a virtual environment using uv with a Python version that Dagster supports: | ||
|
||
```bash | ||
eval "$(pyenv init -)" | ||
eval "$(pyenv virtualenv-init -)" | ||
uv venv --python 3.12 | ||
source .venv/bin/activate | ||
``` | ||
|
||
and finally create and activate the virtualenev: | ||
|
||
```bash | ||
pyenv install 3.10.14 | ||
pyenv virtualenv 3.10.14 dagster310 | ||
pyenv activate dagster310 | ||
``` | ||
<DagsterVersion /> | ||
|
||
3. Ensure that you have node installed by running `node -v`, and that you have [yarn](https://yarnpkg.com/lang/en/) installed. If you are on macOS, you can install yarn with Homebrew: | ||
|
||
|
@@ -44,7 +36,7 @@ We love to see our community members get involved! If you are planning to contri | |
git clone [email protected]:dagster-io/dagster.git | ||
``` | ||
|
||
5. Run `make dev_install` at the root of the repository. This sets up a full Dagster developer environment with all modules and runs tests that do not require heavy external dependencies such as docker. This will take a few minutes. Note that certain sections of the makefile (sanity_check, which is part of `rebuild_ui`) require POSIX compliant shells and will fail on CMD and powershell -- if developing on windows, using something like WSL or git-bash is recommended. Note also that if this command fails while installing python packages, the problem might be resolved by ensuring you are running an up-to-date version of `pip` (upgrade with `pip install -U pip`). | ||
5. Run `make dev_install` at the root of the repository. This sets up a full Dagster developer environment with all modules and runs tests that do not require heavy external dependencies such as docker. This will take a few minutes. Note that certain sections of the makefile (sanity_check, which is part of `rebuild_ui`) require POSIX compliant shells and will fail on CMD and powershell—if developing on windows, using something like WSL or git-bash is recommended. Note also that if this command fails while installing python packages, the problem might be resolved by ensuring you are running an up-to-date version of `pip` (upgrade with `pip install -U pip`). | ||
|
||
```bash | ||
make dev_install | ||
|
@@ -132,7 +124,7 @@ make mdx-format | |
|
||
You can find more information about developing documentation in `docs/README.md`. | ||
|
||
## Picking a Github Issue | ||
## Picking a GitHub Issue | ||
|
||
We encourage you to start with an issue labeled with the tag [`good first issue`](https://github.com/dagster-io/dagster/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+good+first+issue%22) on the [Github issue board](https://github.com/dagster-io/dagster/issues), to get familiar with our codebase as a first-time contributor. | ||
|
||
|
@@ -144,6 +136,6 @@ To submit your code, [fork the Dagster repository](https://help.github.com/en/ar | |
|
||
In the PR template, please describe the change, including the motivation/context, test coverage, and any other relevant information. Please note if the PR is a breaking change or if it is related to an open GitHub issue. | ||
|
||
A Core reviewer will review your PR in around one business day and provide feedback on any changes it requires to be approved. Once approved and all the tests (including Buildkite!) pass, the reviewer will click the Squash and merge button in Github 🥳. | ||
A Core reviewer will review your PR in around one business day and provide feedback on any changes it requires to be approved. Once approved and all the tests (including Buildkite!) pass, the reviewer will click the Squash and merge button in GitHub 🥳. | ||
|
||
Your PR is now merged into Dagster! We’ll shout out your contribution in the weekly release notes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a small typo in this line: "you can install use" should be either "you can install" or "you can use"
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.