Guia de referência da linha de comando

Importante

O que são estas tabelas: Estas tabelas resumem as entradas de linha de comando (por exemplo, pipx install hatch, hatch build ou python -m build) necessárias para concluir todas as etapas do processo de criação de pacote, desde a instalação do Hatch até a publicação do pacote no PyPI e no conda-forge.

O que estas tabelas não são: Estas tabelas não cobrem as etapas manuais ou não automatizadas (por exemplo, criar uma conta no PyPI, criar um API token) que você precisa concluir ao longo do processo de criação do pacote.

Nota sobre sistema operacional: A versão atual deste guia foi testada apenas no Windows. Muitos comandos são específicos do Windows. Comandos específicos por SO são indicados com parênteses após a descrição do comando, por exemplo, [DESCRIÇÃO_DO_COMANDO] (Windows). Os comandos correspondentes para macOS e Linux serão adicionados no futuro.

Configuração do ambiente

Description	Syntax
Set PowerShell execution policy (Windows)	Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Install Scoop (Windows)	Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
Add «main» bucket as download source (Windows)	scoop bucket add main
Add «versions» bucket as download source (Windows)	scoop bucket add versions
Install pipx (Windows)	scoop install pipx or scoop install main/pipx
Update PATH variable with pipx directory	pipx ensurepath
Install hatch	pipx install hatch or pip install hatch
List hatch commands	hatch -h
Open location of hatch config file	hatch config explore
Print contents of hatch config file	hatch config show
Install grayskull	pipx install grayskull or pip install grayskull

Desenvolvimento do pacote

Description	Syntax
Create package structure and baseline contents	hatch new [PACKAGE_NAME]
Install package locally in editable mode	python -m pip install -e .
Install development dependencies	python -m pip install ".[DEPENDENCY_GROUP]"
List packages installed in current environment	pip list
Install package from GitHub	pip install git+https://github.com/user/repo.git@branch_or_tag
Create development environment	hatch env create
Activate development environment	hatch shell
Exit development environment	exit

Publicação do pacote

Description	Syntax
Build package sdist and wheel distributions	hatch build
Publish package to Test PyPI	hatch publish -r test
Install package from Test PyPI	pip install -i https://test.pypi.org/simple/ [PACKAGE_NAME]
Publish package to PyPI	hatch publish
Install package from PyPI	pip install -i https://pypi.org/simple/ [PACKAGE_NAME]
Create conda-forge recipe	grayskull pypi [PACKAGE_NAME]
Check that package installs properly	pip check
Install package from conda-forge	conda install -c conda-forge [PACKAGE_NAME]

Versões e ambientes

Description	Syntax
View environments	hatch env show
Print path to active hatch environment	hatch env find
Bump package version - major	hatch version major
Bump package version - minor	hatch version minor
Bump package version - patch	hatch version patch
Run test scripts on multiple Python versions	hatch run all:[SCRIPT_NAME]