Guía de referencia de línea de comandos

Importante

Qué son estas tablas: Estas tablas resumen los comandos de línea de comandos (por ejemplo, pipx install hatch, hatch build o python -m build) necesarios para completar todos los pasos del proceso de creación de un paquete, desde la instalación de Hatch hasta la publicación del paquete en PyPI y conda-forge.

Qué no son estas tablas: Estas tablas no cubren los pasos manuales o no automatizados (por ejemplo, crear una cuenta de PyPI, generar un token de API) que debes completar durante el proceso de creación del paquete.

Nota sobre el sistema operativo: La versión actual de esta guía ha sido probada únicamente en Windows. Muchos comandos son específicos de este sistema. Los comandos específicos del sistema operativo se indican entre paréntesis después de la descripción del comando, por ejemplo, [DESCRIPCIÓN_DEL_COMANDO] (Windows). Los comandos equivalentes para macOS y Linux se agregarán en el futuro.

Configuración del entorno

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

Desarrollo del paquete

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

Publicación del paquete

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]

Versiones y entornos

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]