API to call PEP 517 hooks for building Python packages https://pep517.readthedocs.io/
Go to file
Thomas Kluyver 3f1949a727 Bump version: 0.8.1 → 0.8.2 2020-04-01 22:05:41 +01:00
pep517 Bump version: 0.8.1 → 0.8.2 2020-04-01 22:05:41 +01:00
tests Add test for subprocess_runner replacement on exception 2019-10-01 00:52:09 -04:00
.bumpversion.cfg Bump version: 0.8.1 → 0.8.2 2020-04-01 22:05:41 +01:00
.gitignore Add tox for testing 2018-07-22 15:58:39 +01:00
.travis.yml Use flit on Travis CI to publish packages 2019-11-23 10:23:59 +00:00
LICENSE Packaging with flit 2017-11-12 18:15:50 +00:00
README.rst Merge pull request #47 from pypa/docs/tox-for-tests 2019-11-23 07:38:02 -05:00
RELEASE.rst Add release instructions. Fixes #29. 2018-12-17 09:36:26 -05:00
appveyor.yml Add tox for testing 2018-07-22 15:58:39 +01:00
dev-requirements.txt Use environment markers in dev-requirements.txt as well 2019-11-23 09:44:13 +00:00
pyproject.toml Merge pull request #70 from encukou/old-backports 2019-11-23 10:47:43 +01:00
pytest.ini Test modules with flake8. Ref #21. 2018-12-13 19:47:53 -05:00
tox.ini pygments is needed for release 2019-11-23 12:46:39 +00:00


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 pytest or tox.

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
import toml
from pep517.wrappers import Pep517HookCaller

src = 'path/to/source'  # Folder containing 'pyproject.toml'
with open(os.path.join(src, 'pyproject.toml')) as f:
    build_sys = toml.load(f)['build-system']

print(build_sys['requires'])  # List of static requirements

hooks = Pep517HookCaller(

config_options = {}   # Optional parameters for backend
# List of dynamic requirements:

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

To build a backend into source and/or binary distributions, run in a shell:

python -m pep517.build path/to/source  # source dir containing pyproject.toml

This 'build' module should be considered experimental while the PyPA decides on the best place for this functionality.