A PEP 517 backend for PDM that supports PEP 621 metadata
Project description
PDM-PEP517
Yet another PEP 517 backend.
This is the backend for PDM projects, while you can also use it alone. It reads the metadata of PEP 621 format and coverts it to Core metadata.
Use as PEP 517 build backend
Edit your pyproject.toml as follows:
[build-system]
requires = ["pdm-pep517"]
build-backend = "pdm.pep517.api"
Tool specific settings
Besides of the standard fields specified in PEP 621, PDM-PEP517 honors some other settings to change the build behavior. They should be defined under [tool.pdm] table:
[tool.pdm]
package-dir = "src" # Similar to setuptools package_dir option
includes = [] # File patterns to include, the paths are relative to the project root.
excludes = [] # File patterns to exclude, the paths are relative to the project root.
source-includes = [] # File patterns to include in source distribution and exclude in wheel distribution
You don't have to specify all of them, PDM-PEP517 can also derive these fields smartly, based on some best practices of Python packaging.
Supported config settings
pdm-pep517 allows passing config_settings to modify the build behavior. It use the same option convention as python setup.py bdist_wheel.
--python-tag
Override the python implementation compatibility tag(e.g. cp37, py3, pp3)
--py-limited-api
Python tag (cp32|cp33|cpNN) for abi3 wheel tag
--plat-name
Override the platform name(e.g. win_amd64, manylinux2010_x86_64)
For example, you can supply these options with build:
python -m build --sdist --wheel --outdir dist/ --config-setting="--python-tag=cp37" --config-setting="--plat-name=win_amd64"
pip doesn't support passing config_settings yet, please stick to build as the recommended frontend.
Support PEP 660 for setuptools backend
If your project need to support editable wheel build(PEP 660) and is backed by setuptools, you can write the following in pyproject.toml:
[build-system]
requires = ["pdm-pep517[setuptools]"]
build-backend = "pdm.pep517.setuptools"
PDM will infer the backend correctly so you don't need to do it.
License
This project is licensed under MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pdm_pep517-0.8.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7a978f2e2f9fb072170c2ccfbce2927318eadd36180a50137cd2f1bbc7a4eaf9 |
|
| MD5 | b7b68cb72795c387be77c0b438a7421f |
|
| BLAKE2b-256 | 4373c430f7e41977d56935591ff2de86c309931a92de8f84bca137ff8d0c55a0 |
