How to configure constraints on the runtime version of Hatch¶

You can specify constraints on the runtime version of Hatch by providing a value for tool.hatch.requires-hatch. If the version of Hatch does not satisfy the given contraints, and Hatch is called with a command that reads the project's metadata, it will exit with an error.

pyproject.toml

[tool.hatch]
requires-hatch = ">=1.18.0"

This is useful if your project relies on features that are only supported by specific versions of Hatch.

The value of the field must be a string containing a valid PEP 440 version specifier set. The field is optional.

Note

This field was introduced in version 1.18.0. Earlier versions of Hatch thus ignore the field, so requires-hatch cannot be used to reject these versions of Hatch.