Wrappers to build Python packages using PEP 517 hooks
Project description
PEP 517 specifies a standard API for systems which build Python packages.
This package contains wrappers around the hooks specified by PEP 517. It provides:
A mechanism to call the hooks in a subprocess, so they are isolated from the current process.
Fallbacks for the optional hooks, so that frontends can call the hooks without checking which are defined.
Higher-level functions which install the build dependencies into a temporary environment and build a wheel/sdist using them.
Run the tests with py.test.
High level usage, with build requirements handled:
import os
from pep517.envbuild import build_wheel, build_sdist
src = 'path/to/source' # Folder containing 'pyproject.toml'
destination = 'also/a/folder'
whl_filename = build_wheel(src, destination)
assert os.path.isfile(os.path.join(destination, whl_filename))
targz_filename = build_sdist(src, destination)
assert os.path.isfile(os.path.join(destination, targz_filename))
Lower level usage—you are responsible for ensuring build requirements are available:
import os
from pep517.wrappers import Pep517HookCaller
src = 'path/to/source' # Folder containing 'pyproject.toml'
hooks = Pep517HookCaller(src)
print(hooks.build_sys_requires) # List of static requirements
config_options = {} # Optional parameters for backend
# List of dynamic requirements:
print(hooks.get_requires_for_build_wheel(config_options))
destination = 'also/a/folder'
whl_filename = hooks.build_wheel(destination, config_options)
assert os.path.isfile(os.path.join(destination, whl_filename))
To test the build backend for a project, run in a system shell:
python3 -m pep517.check path/to/source # source dir containing pyproject.toml
Project details
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 pep517-0.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccf8797a2bf49bb3f91b4a71ae4fa057944765d0f384579ebbf05da8a58a45bf |
|
MD5 | 3625d9588c1b44a6d701a4e44836a26f |
|
BLAKE2b-256 | a96557fb65b6d7f96d62580a3bc4126c46e3a685325eb61e3011803a0f6f24ae |