Hatch

Path to default configuration

Whether to allow direct references

Whether to allow ambiguous features

Configuration for plugin hooks that allow for the modification of project metadata after it has been loaded

Template environment to inherit from. Set to own name to make self referential (disable inheritance from “default”)

Make the environment self-referential and skip project install

List of dependencies to install in the environment

List of extra dependencies to install in the environment in addition to the template environment’s dependencies

List of optional dependency groups (extras) to install

Whether to install the project in development mode

Whether to skip installing the project

Environment variables to set

Glob patterns of environment variables to include

Glob patterns of environment variables to exclude

Dictionary of scripts to run

List of commands to run before installing the project

List of commands to run after installing the project

Python version to use or an absolute path to a python interpreter

List of platforms to build for

Description of the environment for the env show command

Type of environment. Without plugins, the only supported type is "virtual"

Matrix of environments

Format string for matrix names, supporting {variable} and {value} placeholders

Overrides depending on things like platform, matrix variables, or environment variables

Required environment plugins

Custom environment collectors

Required environment collectors for automatic management

Whether to ignore VCS .*ignore files and include those files by default

List of glob patterns to include files

List of glob patterns to exclude files

List of glob patterns to include VCS-ignored files

List of relative paths to directories or files to include, preventing directory traversal from project root. This option overrides any include patterns.

Configuration for plugin hooks that will be executed at various stages of the build process

Additional dependencies to install in the environment

Whether to install the project’s runtime dependencies

A list of the project’s runtime features to install

List of versions to build

List of packages to build

Whether to force include files

Whether to only include non-artifact files in packages

Rewrite relative paths

Whether or not to suppress the error when one has not defined any file selection options and all heuristics have failed to determine what to ship

Additional dependencies installed in the build environment

Whether to install the project’s runtime dependencies

A list of the project’s runtime features to install

Whether to enable current hook (disable to control activation using environment variables)

Whether to ignore VCS .*ignore files and include those files by default

List of glob patterns to include files

List of glob patterns to exclude files

List of glob patterns to include VCS-ignored files

Whether to only include non-artifact files in packages

Rewrite relative paths

Whether to skip excluded directories (for performance reasons)

Whether to make the build reproducible

Directory to write build artifacts to

List of directories to add to PYTHONPATH in development mode

Whether to use an exact dev mode that doesn’t add whole directories to PYTHONPATH

Build targets

Configuration for plugin hooks that will be executed at various stages of the build process

A relative path to a file containing the project version

A regex pattern to extract the version

A source to use for retrieving and updating the version.

Ask for confirmation when publishing to index

Define named repositories to publish to

Publishing index configuration