diff options
author | Monty Taylor <mordred@inaugust.com> | 2021-06-24 08:24:30 -0400 |
---|---|---|
committer | Clark Boylan <clark.boylan@gmail.com> | 2021-11-03 10:05:32 -0700 |
commit | 09ee15341014fc0e3bb8a7c3b06a3fa912cfad38 (patch) | |
tree | 565f7ec56e003422a25701d757b2a412b07dd07a /doc/source/user/using.rst | |
parent | 8c0d5c314108c09bbb3004d608a5a95bd81b8820 (diff) | |
download | pbr-09ee15341014fc0e3bb8a7c3b06a3fa912cfad38.tar.gz |
Add a PEP517 interface5.7.0
pep517 defines a new module method of specifying build backends.
To allow pbr to exist in this world, we should define the interface
that's needed. For this to be used, one will put:
[build-system]
requires = ["pbr>=5.7.0", "setuptools>=36.6.0", "wheel"]
build-backend = "pbr.build"
Into pyproject.toml - and the pep517 interface will be used.
This doesn't really change anything else - it just makes us support this.
So by itself this commit isn't SUPER helpful. But maybe let's take baby
steps with something this prone to strife, yeah?
After this we can start teasing some things apart and doing our
own things directly.
Co-Authored-By: Clark Boylan <clark.boylan@gmail.com>
Change-Id: I293f59b5074a38c78adffe580de2f1533bb01ce7
Diffstat (limited to 'doc/source/user/using.rst')
-rw-r--r-- | doc/source/user/using.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/user/using.rst b/doc/source/user/using.rst index b9659d0..7070e01 100644 --- a/doc/source/user/using.rst +++ b/doc/source/user/using.rst @@ -34,6 +34,18 @@ something like this:: While one can pass any arguments supported by setuptools to ``setup()``, any conflicting arguments supplied in ``setup.cfg`` will take precedence. +``pyproject.toml`` +------------------ + +As an alternative to writing a ``setup.py`` you can instead setup PBR +through the PEP 517 build-system configuration in ``pyproject.toml``. +Your build-system block in ``pyproject.toml`` will need to look something +like this:: + + [build-system] + requires = ["pbr>=5.7.0", "setuptools>=36.6.0", "wheel"] + build-backend = "pbr.build" + .. _setup_cfg: ``setup.cfg`` |