API to call PEP 517 hooks for building Python packages https://pep517.readthedocs.io/
Go to file
Jason R. Coombs 83e8c6dc01 Add --out-dir parameter 2018-12-12 16:11:29 -05:00
pep517 Add --out-dir parameter 2018-12-12 16:11:29 -05:00
tests Explicitly raise an exception if backend isn't available 2018-08-01 14:46:48 +01:00
.gitignore Add tox for testing 2018-07-22 15:58:39 +01:00
.travis.yml Remove Python 3.3 from tests 2018-07-22 16:09:59 +01:00
LICENSE Packaging with flit 2017-11-12 18:15:50 +00:00
README.rst Declare functionality as experimental. 2018-12-12 16:02:22 -05:00
appveyor.yml Add tox for testing 2018-07-22 15:58:39 +01:00
dev-requirements.txt Add tox for testing 2018-07-22 15:58:39 +01:00
pyproject.toml Packaging with flit 2017-11-12 18:15:50 +00:00
tox.ini Add tox for testing 2018-07-22 15:58:39 +01: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 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:

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.