openstack/governance
Code Issues Proposed changes

pti: Update to reference pyproject.toml

Browse Source 
Most projects will eventually use this to specify their dependencies.
Allow it.

Change-Id: I23d5dad8298bc5d117b8aecbfd3804ffac733929
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane
2025-10-03 12:17:49 +01:00
parent 4e811e6921
commit 121ffcbe71
1 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
reference/pti/python.rst
View File

@@ -53,11 +53,16 @@ file in the root of the repository.
Requirements Listing
--------------------
Each project should list its operations dependencies in requirements.txt
and additional dependencies required for testing in test-requirements.txt.
If there are requirements that are specific to python3 or pypy support,
those may be listed in requirements.txt or test-requirements.txt using
environment markers.
Each project should list its required dependencies in either
``project.dependencies`` in ``pyproject.toml`` or in a ``requirements.txt``
file, while additional dependencies required for testing should be listed in
the ``test`` key of ``project.optional-dependencies`` in ``pyproject.toml`` or
in a ``test-requirements.txt`` file.
`Environment marker`__ should be used if there are requirements that are
specific to a given Python version, platform (Windows, Linux, ...), or
implementation (cpython, pypy, ...)
.. __: https://packaging.python.org/en/latest/specifications/dependency-specifiers/#dependency-specifiers
Constraints
===========
@@ -130,10 +135,12 @@ added to that directory are mandatory output artifacts.
Project Configuration
---------------------
All OpenStack projects use `pbr` for consistent operation of setuptools.
To accomplish this, all setup.py files only contain a simple setup function
that setup_requires on an unversioned pbr, and a directive to pass processing
to the pbr library. Actual project configuration is then handled in setup.cfg.
All OpenStack projects use `pbr`__ for consistent operation of setuptools.
To accomplish this, all ``setup.py`` files only contain a simple setup function
that enabled pbr. Actual project configuration is then handled in
``pyproject.toml`` or ``setup.cfg``.
.. __: https://docs.openstack.org/pbr/latest/
Generated Files
---------------