Skip to content

Update instance repo (PR 525 -- Update instructions on hatch/VScode integration) #294

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

Open
scverse-pr-creator wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update instance repo (PR 525 -- Update instructions on hatch/VScode integration) #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .cruft.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse",
"commit": "6cc246194b7f1e940721bade4aad5fb6c469dcd2",
"commit": "3c6cd0e0aed6a91d5b9bd2868bac050c129e1994",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down Expand Up @@ -37,7 +37,7 @@
"trim_blocks": true
},
"_template": "/home/runner/work/cookiecutter-scverse/cookiecutter-scverse",
"_commit": "6cc246194b7f1e940721bade4aad5fb6c469dcd2"
"_commit": "3c6cd0e0aed6a91d5b9bd2868bac050c129e1994"
}
},
"directory": null
Expand Down
11 changes: 7 additions & 4 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,16 +82,18 @@ Next, create the environment with
hatch env create hatch-test.py3.14-stable
```

Then, obtain the path to the environment using
If you are using VScode, install the [hatch-code][] extension.
Now, open the command palette (Ctrl+Shift+P) and search for `Python: Select Interpreter`.
Choose `hatch-test.py3.14-stable` (or your preferred environment) from the dropdown list.

For other IDEs, you can obtain the path to the virtual environments using

```bash
hatch env find hatch-test.py3.14-stable
```

In case you are using VScode, now open the command palette (Ctrl+Shift+P) and search for `Python: Select Interpreter`.
Choose `Enter Interpreter Path` and paste the path to the virtual environment from above.
and manually point it to the python binary.

In this future, this may become easier through a hatch vscode extension.

::::

Expand Down Expand Up @@ -134,6 +136,7 @@ The `.venv` directory is typically automatically discovered by IDEs such as VS C
:::::

[hatch environments]: https://hatch.pypa.io/latest/tutorials/environment/basic-usage/
[hatch-code]: https://marketplace.visualstudio.com/items?itemName=PyPA.hatch
[uv]: https://docs.astral.sh/uv/

## Code-style
Expand Down