mirror of https://github.com/pypa/hatch.git
103 lines
4.6 KiB
Markdown
103 lines
4.6 KiB
Markdown
# Hatch
|
|
|
|
<div class="grid" markdown>
|
|
|
|
{ role="img" }
|
|
|
|
| | |
|
|
| --- | --- |
|
|
| CI/CD | [{ loading=lazy .off-glb }](https://github.com/pypa/hatch/actions/workflows/test.yml) [{ loading=lazy .off-glb }](https://github.com/pypa/hatch/actions/workflows/build-hatch.yml) [{ loading=lazy .off-glb }](https://github.com/pypa/hatch/actions/workflows/build-hatchling.yml) |
|
|
| Docs | [{ loading=lazy .off-glb }](https://github.com/pypa/hatch/actions/workflows/docs-release.yml) [{ loading=lazy .off-glb }](https://github.com/pypa/hatch/actions/workflows/docs-dev.yml) |
|
|
| Package | [{ loading=lazy .off-glb }](https://pypi.org/project/hatch/) [{ loading=lazy .off-glb }](https://pypi.org/project/hatch/) [{ loading=lazy .off-glb }](https://pypi.org/project/hatch/) |
|
|
| Meta | [{ loading=lazy .off-glb }](https://github.com/pypa/hatch) [{ loading=lazy .off-glb }](https://github.com/astral-sh/ruff) [{ loading=lazy .off-glb }](https://github.com/python/mypy) [{ loading=lazy .off-glb }](https://spdx.org/licenses/) [{ loading=lazy .off-glb }](https://github.com/sponsors/ofek) |
|
|
|
|
</div>
|
|
|
|
-----
|
|
|
|
Hatch is a modern, extensible Python project manager. See the [Why Hatch?](why.md) page for more information.
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-hammer-wrench:{ .lg .middle } __Build system__
|
|
|
|
---
|
|
|
|
Reproducible builds by default with a rich ecosystem of plugins
|
|
|
|
[:octicons-arrow-right-24: Configure builds](config/build.md#build-system)
|
|
|
|
- :material-lock:{ .lg .middle } __Environments__
|
|
|
|
---
|
|
|
|
Robust environment management with support for custom scripts
|
|
|
|
[:octicons-arrow-right-24: Getting started](environment.md)
|
|
|
|
- :material-language-python:{ .lg .middle } __Python management__
|
|
|
|
---
|
|
|
|
Choose between easy manual installations or automatic as part of environments
|
|
|
|
[:octicons-arrow-right-24: Try it](cli/reference.md#hatch-python)
|
|
|
|
- :material-magnify-scan:{ .lg .middle } __Static analysis__
|
|
|
|
---
|
|
|
|
Static analysis backed by Ruff with up-to-date, sane defaults
|
|
|
|
[:octicons-arrow-right-24: Learn](config/static-analysis.md)
|
|
|
|
- :material-publish:{ .lg .middle } __Publishing__
|
|
|
|
---
|
|
|
|
Easily upload to PyPI or other indices
|
|
|
|
[:octicons-arrow-right-24: See how](publish.md)
|
|
|
|
- :octicons-number-24:{ .lg .middle } __Versioning__
|
|
|
|
---
|
|
|
|
Streamlined workflow for bumping versions
|
|
|
|
[:octicons-arrow-right-24: Managing versions](version.md)
|
|
|
|
- :octicons-project-template-24:{ .lg .middle } __Project generation__
|
|
|
|
---
|
|
|
|
Create new projects from templates with known best practices
|
|
|
|
[:octicons-arrow-right-24: Project setup](intro.md#setup)
|
|
|
|
- :material-speedometer:{ .lg .middle } __Responsive CLI__
|
|
|
|
---
|
|
|
|
Hatch is up to 3x faster than equivalent tools
|
|
|
|
[:octicons-arrow-right-24: CLI reference](cli/about.md)
|
|
|
|
</div>
|
|
|
|
## License
|
|
|
|
Hatch is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
|
|
|
## Navigation
|
|
|
|
Documentation for specific `MAJOR.MINOR` versions can be chosen by using the dropdown on the top of every page. The `dev` version reflects changes that have not yet been released.
|
|
|
|
Also, desktop readers can use special keyboard shortcuts:
|
|
|
|
| Keys | Action |
|
|
| --- | --- |
|
|
| <ul><li><kbd>,</kbd> (comma)</li><li><kbd>p</kbd></li></ul> | Navigate to the "previous" page |
|
|
| <ul><li><kbd>.</kbd> (period)</li><li><kbd>n</kbd></li></ul> | Navigate to the "next" page |
|
|
| <ul><li><kbd>/</kbd></li><li><kbd>s</kbd></li></ul> | Display the search modal |
|