Skip to content

Commit 797fa24

Browse files
committed
Address PR comments
1 parent 74fa62b commit 797fa24

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

tutorials/command-line-reference.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
**What these tables are:** These tables summarize the command line inputs (e.g., `pipx install hatch`, `hatch build`) necessary to complete all steps in the package creation process, from installing Hatch to publishing the package on PyPI and conda-forge.
55
66
**What these tables are not:** These tables do not cover the manual/non-automated steps (e.g., create PyPI account, create PyPI API token) you have to complete throughout the package creation process.
7+
8+
**Operating system note:** The current iteration of this guide has been tested on the Windows OS only. Many commands are Windows-specific. OS-specific commands are indicated with parentheses after the description of the command, e.g., [COMMAND_DESCRIPTION] (Windows). Corresponding commands for macOS and Linux will be added in the future.
79
```
810

911
## Environment Setup
@@ -14,19 +16,19 @@
1416

1517
| Description | Syntax |
1618
|---|---|
17-
| Set PowerShell execution policy | `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` |
18-
| Install Scoop | `Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression` |
19-
| Add "main" bucket as download source | `scoop bucket add main` |
20-
| Add "versions" bucket as download source | `scoop bucket add versions` |
21-
| Install pipx | `scoop install pipx` or `scoop install main/pipx` |
22-
| Install python | `scoop install python` or `scoop install main/python` |
23-
| Install specific python version | `scoop install versions/python311` |
19+
| Set PowerShell execution policy (Windows) | `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` |
20+
| Install Scoop (Windows) | `Invoke-RestMethod -Uri https://get.scoop.sh \| Invoke-Expression` |
21+
| Add "main" bucket as download source (Windows) | `scoop bucket add main` |
22+
| Add "versions" bucket as download source (Windows) | `scoop bucket add versions` |
23+
| Install pipx (Windows) | `scoop install pipx` or `scoop install main/pipx` |
24+
| Install python (Windows) | `scoop install python` or `scoop install main/python` |
25+
| Install specific python version (Windows) | `scoop install versions/python311` |
2426
| Update PATH variable with pipx directory | `pipx ensurepath` |
25-
| Install hatch | `pipx install hatch` |
27+
| Install hatch | `pipx install hatch` or `pip install hatch` |
2628
| List hatch commands | `hatch -h` |
2729
| Open location of hatch config file | `hatch config explore` |
2830
| Print contents of hatch config file | `hatch config show` |
29-
| Install grayskull | `pipx install grayskull` |
31+
| Install grayskull | `pipx install grayskull` or `pip install grayskull` |
3032

3133
:::
3234

@@ -40,6 +42,7 @@
4042
|---|---|
4143
| Create package structure and baseline contents | `hatch new [PACKAGE_NAME]` |
4244
| Install package locally in editable mode | `python -m pip install -e .` |
45+
| Install development dependencies | `python -m pip install ".[DEPENDENCY_GROUP]"` |
4346
| List packages installed in current environment | `pip list` |
4447
| Install package from GitHub | `pip install git+https://github.com/user/repo.git@branch_or_tag` |
4548
| Create development environment | `hatch env create` |
@@ -67,15 +70,15 @@
6770

6871
:::
6972

70-
## Miscellaneous Commands
73+
## Versions and Environments
7174

7275
:::{table}
7376
:widths: auto
7477
:align: center
7578

7679
| Description | Syntax |
7780
|---|---|
78-
| View environments hatch has access to | `hatch env show` |
81+
| View environments | `hatch env show` |
7982
| Print path to active hatch environment | `hatch env find` |
8083
| Bump package version - major | `hatch version major` |
8184
| Bump package version - minor | `hatch version minor` |

0 commit comments

Comments
 (0)