Chapter 7. Packaging Python 3 RPMs
You can install Python packages on your system by using the DNF package manager. DNF uses the RPM package format, which offers more downstream control over the software.
Packaging a Python project into an RPM package provides the following advantages compared to native Python packages:
- Dependencies on Python and non-Python packages are possible and strictly enforced by the DNF package manager.
- You can cryptographically sign the packages. With cryptographic signing, you can verify, integrate, and test contents of RPM packages with the rest of the operating system.
- You can run tests during the build process.
The packaging format of native Python packages follows the specifications published by the Python Packaging Authority (PyPA). Historically, most Python projects used the distutils or setuptools utilities for packaging and defined package information in the setup.py file. However, options for creating native Python packages have evolved over time:
To package Python software, whether the project uses setup.py or pyproject.toml, use pyproject RPM macros from the pyproject-rpm-macros package.
7.1. A spec file description for an example Python package Copy linkLink copied to clipboard!
Review the notes about Python RPM spec file specifics in the following example of the python3-pello package.
The RPM spec file for Python projects has some specifics compared to non-Python RPM spec files. For example, it is recommended for any RPM package name of a Python library to include the python3- prefix.
Example 7.1. An example spec file for the program written in Python
%global python3_pkgversion 3
Name: python-pello
Version: 1.0.2
Release: 1%{?dist}
Summary: Example Python library
License: MIT
URL: https://github.com/fedora-python/Pello
Source: %{url}/archive/v%{version}/Pello-%{version}.tar.gz
BuildArch: noarch
BuildRequires: python%{python3_pkgversion}-devel
# Build dependencies need to be specified manually
BuildRequires: python%{python3_pkgversion}-setuptools
# Test dependencies need to be specified manually
# Runtime dependencies need to be BuildRequired manually to run tests during build
BuildRequires: python%{python3_pkgversion}-pytest >= 3
%global _description %{expand:
Pello is an example package with an executable that prints Hello World! on the command line.}
%description %_description
%package -n python%{python3_pkgversion}-pello
Summary: %{summary}
%description -n python%{python3_pkgversion}-pello %_description
%prep
%autosetup -p1 -n Pello-%{version}
%build
# The macro only supports projects with setup.py
%py3_build
%install
# The macro only supports projects with setup.py
%py3_install
%check
%pytest
# Note that there is no %%files section for python-pello
%files -n python%{python3_pkgversion}-pello
%doc README.md
%license LICENSE.txt
%{_bindir}/pello_greeting
# The library files needed to be listed manually
%{python3_sitelib}/pello/
# The metadata files needed to be listed manually
%{python3_sitelib}/Pello-*.egg-info/
-
By defining the
python3_pkgversionmacro, you set which Python version this package will be built for. To build for the default Python version3.12, remove the line. -
When packaging a Python project into RPM, always add the
python-prefix to the original name of the project. The project name here isPelloand, therefore, the name of the Source RPM (SRPM) ispython-pello. -
BuildRequiresspecifies what packages are required to build and test this package. InBuildRequires, always includepython3-develand other tools that you need to build Python packages. Also list the projects that your software requires, such aspython3-setuptools. Add any runtime and testing dependencies that you need to run tests in the%checksection. -
When choosing a name for the binary RPM (the package that users will be able to install), add a versioned Python prefix. Use the
python3-prefix for the default Python 3.12. You can use the%{python3_pkgversion}macro, which evaluates to3for the default Python version3.12unless you set it to an explicit version, for example, when a later version of Python is available (see footnote 1). The
%py3_buildand%py3_installmacros run thesetup.py buildandsetup.py installcommands, respectively, with additional arguments to specify installation locations, the interpreter to use, and other details.NoteUsing the
setup.py buildandsetup.py installcommands from thesetuptoolspackage is deprecated. For modern projects, use thepyprojectRPM macros from thepyproject-rpm-macrospackage. For more information, see Packaging Python projects with pyproject RPM macros.-
The
%checksection runs the tests of the packaged project. The exact command depends on the project itself, but you can use the%pytestmacro to run thepytestcommand in an RPM-friendly way.
7.2. Common macros for Python 3 RPMs Copy linkLink copied to clipboard!
In a Python RPM spec file, always use the macros for Python 3 RPMs rather than hardcoding their values.
You can redefine which Python 3 version is used in these macros. To do so, define the python3_pkgversion macro at the top of your spec file. For more information, see A spec file description for an example Python package. If you define the python3_pkgversion macro, the macro values in the following table match that Python 3 version.
| Macro | Normal Definition | Description |
|---|---|---|
| %{python3_pkgversion} | 3 | The Python version that is used by all other macros. Redefine this macro when you build for a different Python version than the default. |
| %{python3} | /usr/bin/python3 | The Python 3 interpreter. |
| %{python3_version} | 3.12 | The major.minor version of the Python 3 interpreter. |
| %{python3_sitelib} | /usr/lib/python3.12/site-packages | The location where pure-Python modules are installed. |
| %{python3_sitearch} | /usr/lib64/python3.12/site-packages | The location where modules containing architecture-specific extension modules are installed. |
| %py3_build |
Expands to the | |
| %py3_install |
Expands to the | |
| %{py3_shebang_flags} | sP |
The default set of flags for the Python interpreter directives macro, |
| %py3_shebang_fix |
Changes Python interpreter directives to |
7.3. Using automatically generated dependencies for Python RPMs Copy linkLink copied to clipboard!
Enable automatic generation of dependencies for Python RPMs by using upstream-provided metadata.
Prerequisites
-
A
specfile for the RPM exists. For more information, see Aspecfile description for an example Python package.
Procedure
Include one of the following directories in the resulting RPM:
-
.dist-info .egg-infoThe RPM build process automatically generates virtual
pythonX.Ydistprovides from these directories, for example:python3.12dist(pello)The Python dependency generator then reads the upstream metadata and generates runtime requirements for each RPM package using the generated
pythonX.Ydistvirtual provides. Example of a generated requirements tag:Requires: python3.12dist(requests)
-
-
Inspect the generated
Requires. -
To remove some of the generated
Requires, modify the upstream-provided metadata in the%prepsection of thespecfile. -
To disable the automatic requirements generator, include the
%{?python_disable_dependency_generator}macro immediately before the main package’s%descriptiondeclaration.
7.4. Packaging Python projects with pyproject RPM macros Copy linkLink copied to clipboard!
Package Python projects that use a pyproject.toml or a setup.py file into RPM packages by using pyproject RPM macros from the CodeReady Linux Builder (CRB) repository.
7.4.1. pyproject RPM macros for Python packaging Copy linkLink copied to clipboard!
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.
7.4.2. Preparing to use pyproject RPM macros Copy linkLink copied to clipboard!
To package Python projects with pyproject RPM macros, enable the CodeReady Linux Builder (CRB) repository on the build host and configure %pyproject_buildrequires in your RPM spec file.
Red Hat does not support content in the CodeReady Linux Builder repository.
Prerequisites
- You have root permissions on the build host.
- The system is registered with Red Hat Subscription Manager.
Procedure
Enable the CodeReady Linux Builder repository on the build host:
# subscription-manager repos --enable codeready-builder-for-rhel-10-x86_64-rpmsIn the RPM
specfile, addBuildRequires: python3-develand use the%pyproject_buildrequiresmacro in the%generate_buildrequiressection:BuildRequires: python3-devel %generate_buildrequires %pyproject_buildrequires
7.4.3. Common pyproject RPM macros for Python 3 RPMs Copy linkLink copied to clipboard!
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.14. 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.
| Macro | Description |
|---|---|
| %pyproject_buildrequires |
Expands build requirements from upstream metadata. Use options such as |
| %pyproject_wheel | Builds a wheel package by using the upstream-specified build backend. |
| %pyproject_install | Installs the built wheel package into the build root. |
| %pyproject_save_files |
Saves the list of installed files for use in the |
| %pyproject_check_import |
Verifies that the installed package can be imported during the |
| %pyproject_files |
Expands to the file list saved by |
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.
7.4.4. A spec file description for a Python package with pyproject RPM macros Copy linkLink copied to clipboard!
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.
Example 7.2. An example spec file for a Python library built with pyproject RPM macros
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}
-
The
%pyproject_buildrequiresmacro in the%generate_buildrequiressection creates build requirements from upstream metadata. -
The
%pyproject_wheelmacro builds a wheel package by using the upstream-specified build backend. -
The
%pyproject_installmacro installs the wheel into the build root. -
The
%pyproject_save_files -l pellomacro records installed files. The-loption verifies that a license file is present. Thepelloargument lists the importable module namedpello. -
The
%checksection runs%pyproject_check_importto verify importability and%pytestto run tests. -
The
%filessection uses-f %{pyproject_files}to include the file list generated by%pyproject_save_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.