mirror of https://github.com/pypa/hatch.git
54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
# Source distribution builder
|
|
|
|
-----
|
|
|
|
A source distribution, or `sdist`, is an archive of Python "source code". Although largely unspecified, by convention it should include everything that is required to build a [wheel](wheel.md) without making network requests.
|
|
|
|
## Configuration
|
|
|
|
The builder plugin name is `sdist`.
|
|
|
|
```toml config-example
|
|
[tool.hatch.build.targets.sdist]
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Default | Description |
|
|
| --- | --- | --- |
|
|
| `core-metadata-version` | `"2.3"` | The version of [core metadata](https://packaging.python.org/specifications/core-metadata/) to use |
|
|
| `strict-naming` | `true` | Whether or not file names should contain the normalized version of the project name |
|
|
| `support-legacy` | `false` | Whether or not to include a `setup.py` file to support legacy installation mechanisms |
|
|
|
|
## Versions
|
|
|
|
| Version | Description |
|
|
| --- | --- |
|
|
| `standard` (default) | The latest conventional format |
|
|
|
|
## Default file selection
|
|
|
|
When the user has not set any [file selection](../../config/build.md#file-selection) options, all files that are not [ignored by your VCS](../../config/build.md#vcs) will be included.
|
|
|
|
!!! note
|
|
The following files are always included and cannot be excluded:
|
|
|
|
- `/pyproject.toml`
|
|
- `/hatch.toml`
|
|
- `/hatch_build.py`
|
|
- `/.gitignore` or `/.hgignore`
|
|
- Any defined [`readme`](../../config/metadata.md#readme) file
|
|
- All defined [`license-files`](../../config/metadata.md#license)
|
|
|
|
## Reproducibility
|
|
|
|
[Reproducible builds](../../config/build.md#reproducible-builds) are supported.
|
|
|
|
## Build data
|
|
|
|
This is data that can be modified by [build hooks](../build-hook/reference.md).
|
|
|
|
| Data | Default | Description |
|
|
| --- | --- | --- |
|
|
| `dependencies` | | Extra [project dependencies](../../config/metadata.md#required) |
|