mirror of https://github.com/pypa/hatch.git
46 lines
2.2 KiB
Markdown
46 lines
2.2 KiB
Markdown
# 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/)
|