File: index.rst

package info (click to toggle)
python-pyproject-hooks 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 348 kB
  • sloc: python: 973; sh: 5; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 1,302 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
pyproject-hooks
===============

This is a low-level library for calling build-backends in ``pyproject.toml``-based project. It provides the basic functionality to help write tooling that generates distribution files from Python projects.

What this library provides
--------------------------

- Logic for calling build-backend hooks in a subprocess.
- Automated fallbacks for optional build-backend hooks.
- Control over how the subprocesses are run.

What this library does not provide
----------------------------------

- Environment management / isolation

  It is the responsibility of the caller to setup an environment containing the build dependencies, and provide a ``python_executable`` to this library to use that environment. It is also the caller's responsibility to install any "additional" dependencies before calls to certain hooks.

- A command line interface

  This is a low-level library that would simplify writing such an interface but providing a command line interface is out-of-scope for this project.

These roles are covered by tools like `build <https://pypa-build.readthedocs.io/en/stable/>`_, which use this library.

.. toctree::
   :caption: API reference
   :hidden:

   pyproject_hooks

.. toctree::
   :caption: Project
   :hidden:

   changelog
   release-process