CheatPress

Hatch Python project manager

Version 1.18.1 · source

Hatch, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Hatch, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Hatch, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Hatch, A5, light preview Light · A5 148 × 210 mm · PDF Hatch, A5, dark preview Dark · A5 148 × 210 mm · PDF Hatch, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Hatch, A4, light preview Light · A4 210 × 297 mm · PDF Hatch, A4, dark preview Dark · A4 210 × 297 mm · PDF Hatch, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Hatch, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Hatch, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Hatch, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Hatch, A3, light preview Light · A3 297 × 420 mm · PDF Hatch, A3, dark preview Dark · A3 297 × 420 mm · PDF Hatch, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Hatch, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Hatch, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Hatch, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Hatch, Letter, light preview Light · Letter 8.5 × 11 in · PDF Hatch, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Hatch, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Hatch, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Hatch, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Hatch, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

hatch new <name>
Create a project
hatch shell
Enter the default env
hatch run <cmd>
Run in an env
hatch run test:<cmd>
Run in the test env
hatch test
Run the test matrix
hatch fmt
Format and lint
hatch version patch
Bump the version
hatch build
Make sdist and wheel

Concepts

  1. pyproject.toml envs, scripts, version
  2. Environment isolated virtualenv
  3. dist/ sdist and wheel
  4. Index PyPI
From source to release

Projects

hatch new <name>
Create a project skeleton
hatch new --cli <name>
Include a command line entry point
hatch new --init
Convert an existing project
Reads setup.py or requirements files and writes a pyproject.toml.
hatch project metadata
Show the resolved metadata

Environments

hatch shell
Enter the default env shell
hatch shell <env>
Enter a named env shell
hatch env create
Create the default env
hatch env create <env>
Create a named env
hatch env show
List the configured envs
hatch env find <env>
Print an env's path
hatch env remove <env>
Delete an env
hatch env prune
Delete all envs

Running commands

hatch run <cmd>
Run a command in the default env
hatch run <env>:<cmd>
Run a command in a named env
hatch run <script>
Run a script defined in config
hatch -e <env> run <cmd>
Pick the env with a flag
HATCH_ENV does the same from the environment.
hatch run +py=3.12 <env>:<cmd>
Select matrix envs by variable
hatch run -py=3.9 <env>:<cmd>
Exclude matrix envs by variable

Testing and quality

hatch test
Run tests in the matrix
hatch test -c
Measure coverage
hatch test -a
Test every matrix env
hatch test -py 3.12
Test one Python version
hatch test -p
Run tests in parallel
hatch test <path>::<test>
Pass arguments to pytest
hatch fmt
Format and fix lint errors
hatch fmt --check
Check only, change nothing
hatch fmt -l
Run the linter only
hatch fmt -f
Run the formatter only
hatch fmt --sync
Sync the default Ruff config
hatch check
Run code, format and type checks

Versioning

hatch version
Show the project version
hatch version <x.y.z>
Set an exact version
hatch version patch
Bump the patch number
hatch version minor
Bump the minor number
hatch version major
Bump the major number

Build and publish

hatch build
Build sdist and wheel into dist/
hatch build -t wheel
Build one target only
hatch build -c
Clean old artifacts first
hatch clean
Remove build artifacts
hatch publish
Upload artifacts to the index
hatch publish -r test
Upload to the test index
hatch publish -u __token__ -a <token>
Authenticate with a token

Dependencies and Python

hatch dep show requirements
List env dependencies
hatch dep show table
List dependencies as a table
hatch lock
Write a lockfile for the env
Alias of hatch dep lock; locks the env chosen with -e.
hatch python show
Show available Python builds
hatch python install <version>
Install a managed Python

Config in pyproject.toml

[tool.hatch.version]
Where the version comes from
[tool.hatch.envs.<name>]
Env deps and scripts
[[tool.hatch.envs.<name>.matrix]]
Env variants
hatch config show
Print the user config
hatch self update
Upgrade Hatch itself

Recipes

Env with scripts and a matrix
# pyproject.toml[tool.hatch.envs.test]dependencies = ["pytest"][tool.hatch.envs.test.scripts]run = "pytest {args}"[[tool.hatch.envs.test.matrix]]python = ["3.11", "3.12"]
Version from a file
# pyproject.toml[project]dynamic = ["version"][tool.hatch.version]path = "src/demo/__about__.py"
Release a new version
hatch version minorhatch build -chatch publish -r testhatch publish