Skip to content

docs: update readme #190

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

Merged
flying-sheep merged 5 commits into from
May 28, 2026
Merged

docs: update readme #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
51f85ee
docs: update readme
flying-sheep May 28, 2026
e8053eb
fix
flying-sheep May 28, 2026
5f0509c
update node version
flying-sheep May 28, 2026
89edd83
up
flying-sheep May 28, 2026
f37517b
more up
flying-sheep May 28, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
fail-fast: false
matrix:
node-version:
- '24'
- '26'
steps:
- name: Clone repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
Expand Down
1 change: 1 addition & 0 deletions .vscodeignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ test/**
*.yaml
*.yml
*.jsonc
*.png
vsc-extension-quickstart.md
**/tsconfig.json
**/*.map
Expand Down
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ To make use of it, make sure your user settings contain `"python.useEnvironments

## Features
- List all configured [Hatch environments]
- Provide controls to set them as active environment for your project, activate them in a terminal, and remove them[^1]
- Temporarily[^2] modify an environment’s packages using the configured [`installer`]
- Provide controls to set them as active environment for your project, activate them in a terminal, and delete them from disk
- Temporarily modify an environment’s packages using the configured [`installer`]

[^1]: “remove” in this context means deleting it on disk, it will stay listed and will be recreated when interacting with it.
[^2]: since many actions currently use `hatch run` and therefore sync the environment, e.g. removing a package that is pulled in as a dependency will not persist for long.
![screenshot](./screenshot.png)

Since many actions currently use `hatch run` and therefore sync the environment, temporary package changes can be quickly undone, especially removing packages installed as dependencies.
Persistent modifications to the installed packages should be done by editing Hatch’s `envs` configuration.

[`installer`]: https://hatch.pypa.io/latest/how-to/environment/select-installer/

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
"rolldown": "^1.0.2",
"typescript": "^6.0.3"
},
"packageManager": "yarn@4.14.1",
"packageManager": "yarn@4.15.0",
"dependencies": {
"@vscode/python-environments": "^1.0.0",
"untildify": "^6.0.0",
Expand Down
Binary file added screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 35 additions & 45 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Manual changes might be lost - proceed with caution!

__metadata:
version: 9
version: 10
cacheKey: 10

"@azu/format-text@npm:^1.0.1, @azu/format-text@npm:^1.0.2":
Expand Down Expand Up @@ -92,8 +92,8 @@ __metadata:
linkType: hard

"@azure/identity@npm:^4.1.0":
version: 4.9.1
resolution: "@azure/identity@npm:4.9.1"
version: 4.13.1
resolution: "@azure/identity@npm:4.13.1"
dependencies:
"@azure/abort-controller": "npm:^2.0.0"
"@azure/core-auth": "npm:^1.9.0"
Expand All @@ -102,11 +102,11 @@ __metadata:
"@azure/core-tracing": "npm:^1.0.0"
"@azure/core-util": "npm:^1.11.0"
"@azure/logger": "npm:^1.0.0"
"@azure/msal-browser": "npm:^4.2.0"
"@azure/msal-node": "npm:^3.5.0"
"@azure/msal-browser": "npm:^5.5.0"
"@azure/msal-node": "npm:^5.1.0"
open: "npm:^10.1.0"
tslib: "npm:^2.2.0"
checksum: 10/55afd98f3ba554917b1a474ea2f573456fdfc773677cf1814e2b62cf6479d3d87659cd17ef05e214e4625afa5fdca73cce6add0df161fa459ba58a8a2bd9de49
checksum: 10/f07734f811d734d29b49ad7f8345a53d680b90d075dcd9bfbc28e2e18bda3f1688de4faf44cc4727302c9aa91c13d4444ac2de6edb88a79c99c9efc660137609
languageName: node
linkType: hard

Expand All @@ -120,30 +120,29 @@ __metadata:
languageName: node
linkType: hard

"@azure/msal-browser@npm:^4.2.0":
version: 4.12.0
resolution: "@azure/msal-browser@npm:4.12.0"
"@azure/msal-browser@npm:^5.5.0":
version: 5.11.0
resolution: "@azure/msal-browser@npm:5.11.0"
dependencies:
"@azure/msal-common": "npm:15.6.0"
checksum: 10/1ce558363de16362c7091e2fe572d9e4ab33a85f65feac37f20832fa6676da0f686c4036961eeba74bbc1c60b48c235ff306ef4d762d51d39b548b8f35307f75
"@azure/msal-common": "npm:16.6.2"
checksum: 10/48049d2e2cdcfdfc9bd03ddb95737f84e2005084d84e55f4adca6d8681a81745a5ecd48c01b20b8623091744664403dcc6ce726212e193f4bf63bda49b19d3e2
languageName: node
linkType: hard

"@azure/msal-common@npm:15.6.0":
version: 15.6.0
resolution: "@azure/msal-common@npm:15.6.0"
checksum: 10/975ad7821fa5bdc682c9ef08e02642923571b715f199e94c9fbda17248b301caae5cf9cddfa2fdf37f4a05cce7eaf3ddebaef28f83909d78f452caf72367022a
"@azure/msal-common@npm:16.6.2":
version: 16.6.2
resolution: "@azure/msal-common@npm:16.6.2"
checksum: 10/df446034a983f44264679489521349d961943518671fb411f7af06f67de3797a756cc35975514828d70a05766771cc619ae990531830631e077dfc1e1d16b1e2
languageName: node
linkType: hard

"@azure/msal-node@npm:^3.5.0":
version: 3.5.3
resolution: "@azure/msal-node@npm:3.5.3"
"@azure/msal-node@npm:^5.1.0":
version: 5.2.2
resolution: "@azure/msal-node@npm:5.2.2"
dependencies:
"@azure/msal-common": "npm:15.6.0"
"@azure/msal-common": "npm:16.6.2"
jsonwebtoken: "npm:^9.0.0"
uuid: "npm:^8.3.0"
checksum: 10/58c3755c67cdbe06e8319e48b3917086331738de00ddd3dc44f682e7b776f48425d785c5450413982830a36a73961cd72d868b3ec0f9acc39435050d328b61f4
checksum: 10/29cf3d594207a59d01f4f04ca48203391eca3bf7c389a6a51d4a531b30b83cb990c223deee26c99ceaee8f48f3846d3b006b33c4eefc765f37646e442a79572f
languageName: node
linkType: hard

Expand Down Expand Up @@ -1755,7 +1754,7 @@ __metadata:
languageName: node
linkType: hard

"buffer-equal-constant-time@npm:1.0.1":
"buffer-equal-constant-time@npm:^1.0.1":
version: 1.0.1
resolution: "buffer-equal-constant-time@npm:1.0.1"
checksum: 10/80bb945f5d782a56f374b292770901065bad21420e34936ecbe949e57724b4a13874f735850dd1cc61f078773c4fb5493a41391e7bda40d1fa388d6bd80daaab
Expand Down Expand Up @@ -3250,10 +3249,10 @@ __metadata:
linkType: hard

"jsonwebtoken@npm:^9.0.0":
version: 9.0.2
resolution: "jsonwebtoken@npm:9.0.2"
version: 9.0.3
resolution: "jsonwebtoken@npm:9.0.3"
dependencies:
jws: "npm:^3.2.2"
jws: "npm:^4.0.1"
lodash.includes: "npm:^4.3.0"
lodash.isboolean: "npm:^3.0.3"
lodash.isinteger: "npm:^4.0.4"
Expand All @@ -3263,7 +3262,7 @@ __metadata:
lodash.once: "npm:^4.0.0"
ms: "npm:^2.1.1"
semver: "npm:^7.5.4"
checksum: 10/6e9b6d879cec2b27f2f3a88a0c0973edc7ba956a5d9356b2626c4fddfda969e34a3832deaf79c3e1c6c9a525bc2c4f2c2447fa477f8ac660f0017c31a59ae96b
checksum: 10/a67a276db41fbfb458ebdc4938d5d7b01d4743e16bda0f25ac01996fe5b5819d66656153f6cfce19b4680b79ae9f9ca185965defc22e77e0abddf443573238d6
languageName: node
linkType: hard

Expand All @@ -3279,24 +3278,24 @@ __metadata:
languageName: node
linkType: hard

"jwa@npm:^1.4.1":
version: 1.4.1
resolution: "jwa@npm:1.4.1"
"jwa@npm:^2.0.1":
version: 2.0.1
resolution: "jwa@npm:2.0.1"
dependencies:
buffer-equal-constant-time: "npm:1.0.1"
buffer-equal-constant-time: "npm:^1.0.1"
ecdsa-sig-formatter: "npm:1.0.11"
safe-buffer: "npm:^5.0.1"
checksum: 10/0bc002b71dd70480fedc7d442a4d2b9185a9947352a027dcb4935864ad2323c57b5d391adf968a3622b61e940cef4f3484d5813b95864539272d41cac145d6f3
checksum: 10/b04312a1de85f912b96aa3a7211717b8336945fab5b4f7cbc7800f4c80934060c0a3111576fad8d76e41ad62887d6da4b21fd4c47e45c174197f8be7dc0c1694
languageName: node
linkType: hard

"jws@npm:^3.2.2":
version: 3.2.2
resolution: "jws@npm:3.2.2"
"jws@npm:^4.0.1":
version: 4.0.1
resolution: "jws@npm:4.0.1"
dependencies:
jwa: "npm:^1.4.1"
jwa: "npm:^2.0.1"
safe-buffer: "npm:^5.0.1"
checksum: 10/70b016974af8a76d25030c80a0097b24ed5b17a9cf10f43b163c11cb4eb248d5d04a3fe48c0d724d2884c32879d878ccad7be0663720f46b464f662f7ed778fe
checksum: 10/75d7b157489fa9a72023712c58a7a7706c7e2b10eec27fabd3bb9cae0c9e492251ab72527d20a8a5f5726196f0508c320c643fddff7076657f6bca16d0ceeeeb
languageName: node
linkType: hard

Expand Down Expand Up @@ -5380,15 +5379,6 @@ __metadata:
languageName: node
linkType: hard

"uuid@npm:^8.3.0":
version: 8.3.2
resolution: "uuid@npm:8.3.2"
bin:
uuid: dist/bin/uuid
checksum: 10/9a5f7aa1d6f56dd1e8d5f2478f855f25c645e64e26e347a98e98d95781d5ed20062d6cca2eecb58ba7c84bc3910be95c0451ef4161906abaab44f9cb68ffbdd1
languageName: node
linkType: hard

"v8-to-istanbul@npm:^9.0.0":
version: 9.3.0
resolution: "v8-to-istanbul@npm:9.3.0"
Expand Down