Chapter 3. Packaging Python 3 RPMs

Package Python projects into RPM packages by using pyproject RPM macros. These macros work with projects that define metadata in setup.py, pyproject.toml, or both, and invoke a standards-based build backend through a standardized protocol.

Many upstream Python projects no longer rely on a setup.py script. Instead, they store project metadata in pyproject.toml and use a build backend, such as setuptools, flit-core, hatchling, or poetry-core. The pyproject RPM macros invoke any compliant build backend through a standardized protocol instead of calling setup.py directly.

The pyproject RPM macros reuse upstream metadata whenever possible. For example, they can generate BuildRequires from the build-system requirements in pyproject.toml instead of listing the same dependencies manually in the spec file.

The pyproject-rpm-macros package is available in the CodeReady Linux Builder (CRB) repository. The %pyproject_buildrequires macro adds a generated BuildRequires on that package during package builds. CRB content is unsupported by Red Hat. The macros are updated as needed to follow emerging Python packaging standards.

Use pyproject RPM macros to package Python projects, whether the upstream project defines metadata in setup.py, pyproject.toml, or both.

Package Python projects by using pyproject RPM macros in an RPM spec file. The %pyproject_buildrequires macro adds a generated BuildRequires on the pyproject-rpm-macros package, so you do not install that package manually on the build host. Enable the CodeReady Linux Builder (CRB) repository on the build host so the dependency is available during package builds.

In a Python RPM spec file, use pyproject RPM macros to build projects that define metadata in setup.py, pyproject.toml, or both.

You can redefine which Python 3 version the macros use by defining the python3_pkgversion macro at the top of your spec file, for example %global python3_pkgversion 3.12. Omit this macro to build for the default Python 3 version.

Place %pyproject_buildrequires in the %generate_buildrequires section of the spec file. RPM runs the macro in that section to generate build requirements from upstream metadata before the build starts.

The table lists commonly used macros. For all macros and their options, see the /usr/share/doc/pyproject-rpm-macros/README.md file provided by the pyproject-rpm-macros package.

Use an annotated RPM spec file example to package a Python project that defines metadata in setup.py, pyproject.toml, or both. The example shows pyproject RPM macros for build requirements, wheel builds, installation, and automated file lists.

Name:           python-pello
Version:        1.0.2
Release:        1%{?dist}
Summary:        Example Python library

License:        MIT
URL:            https://example.com/Pello
Source:         %{url}/archive/v%{version}/Pello-%{version}.tar.gz

BuildArch:      noarch

%description %_description
Pello is an example package with an executable that prints Hello World! on the command line.

%package -n python3-pello
Summary:        %{summary}

%description -n python3-pello
Pello is an example package with an executable that prints Hello World! on the command line.

%prep
%autosetup -p1 -n Pello-%{version}

%generate_buildrequires
%pyproject_buildrequires

%build
%pyproject_wheel

%install
%pyproject_install

%pyproject_save_files -l pello

%check
%pyproject_check_import
%pytest

%files -n python3-pello -f %{pyproject_files}

For commonly used macros, see Common pyproject RPM macros for Python 3 RPMs. For all macros and their options, see the /usr/share/doc/pyproject-rpm-macros/README.md file provided by the pyproject-rpm-macros package.