1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
|
# Hatchling
<div align="center">
<img src="https://raw.githubusercontent.com/pypa/hatch/master/docs/assets/images/logo.svg" alt="Hatch logo" width="500" role="img">
| | |
| --- | --- |
| Package | [](https://pypi.org/project/hatchling/) [](https://pypi.org/project/hatchling/) [](https://pypi.org/project/hatchling/) |
| Meta | [](https://github.com/pypa/hatch) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |
</div>
-----
This is the extensible, standards compliant build backend used by [Hatch](https://github.com/pypa/hatch).
## Usage
The following snippet must be present in your project's `pyproject.toml` file in order to use Hatchling as your build backend:
```toml
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
```
Then a build frontend like [pip](https://github.com/pypa/pip), [build](https://github.com/pypa/build), or Hatch itself can build or install your project automatically:
```console
# install using pip
pip install /path/to/project
# build
python -m build /path/to/project
# build with Hatch
hatch build /path/to/project
```
## Documentation
- [Project metadata](https://hatch.pypa.io/latest/config/metadata/)
- [Dependencies](https://hatch.pypa.io/latest/config/dependency/)
- [Packaging](https://hatch.pypa.io/latest/config/build/)
|