Skip to content

Update instructions on hatch/VScode integration - #525

Merged
grst merged 7 commits into
mainfrom
hatch-vcs
Jul 14, 2026
Merged

Update instructions on hatch/VScode integration#525
grst merged 7 commits into
mainfrom
hatch-vcs

Conversation

@grst

@grst grst commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Close #424

For now, environment creation is still a manual step. See also pypa/hatch-code#229

Ideally, at some point we could shorten our instructions in favor of a link to the offical hatch docs: pypa/hatch#2336

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

A PR has been generated to the instance repo: scverse/cookiecutter-scverse-instance#294

Checks Status Documentation Preview

You can check out the PR to preview your changes in an instance of the cookiecutter template.
It will be kept in sync with this PR automatically.

@flying-sheep flying-sheep left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For troubleshooting, we should also mention that you need

  1. vscode-python-environments1 and hatch-code installed
  2. "python.useEnvironmentsExtension": true

There are three code paths in the Python extension:

  1. No vscode-python-environments1: Builtin Hatch support with old code path and interface works
  2. (the default for now) Have vscode-python-environments installed and "python.useEnvironmentsExtension": false results in no Hatch integration
  3. Have vscode-python-environments and hatch-code installed and "python.useEnvironmentsExtension": true uses the currently best possible Hatch integration using the new interface

Footnotes

  1. vscode-python-environments is installed by default when you install the Python extension but some people manually uninstalled it 2

@grst

grst commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator Author

Getting quite complicated. Shall we wait for pypa/hatch#2336 and reference that?

@flying-sheep

Copy link
Copy Markdown
Member

No, the explanation is complicated, but I don’t consider these instructions complicated:

you need vscode-python-environments and hatch-code installed and "python.useEnvironmentsExtension": true set.

That’s all very easily verifiable and achievable for any VS Code user.

@grst
grst requested a review from flying-sheep July 14, 2026 07:05
Comment thread {{cookiecutter.project_name}}/docs/contributing.md Outdated
Comment thread {{cookiecutter.project_name}}/docs/contributing.md Outdated
grst and others added 2 commits July 14, 2026 14:23
Co-authored-by: Philipp A. <flying-sheep@web.de>
Co-authored-by: Philipp A. <flying-sheep@web.de>
Comment thread {{cookiecutter.project_name}}/docs/contributing.md Outdated
This was referenced Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

hatch/vscode integration

2 participants