Four steps to package a new Python module

When you install an application, you are usually installing a software package that contains the application's executable code and important files such as documents, icons, etc. On Linux, software is generally packaged into formats such as RPM or DEB. Users can install it through commands such as ​​dnf​​​ or ​​apt​​​ , depending on the Linux distribution you are using. However, new Python modules are released almost every day, so it's easy to come across a Python module that hasn't been packaged yet. This is the meaning of ​​pyp2rpm​​.

Recently I was trying to install a module called ​​python-concentration​​, but the progress was not very smooth:

$ sudo dnf install python-concentration
Updating Subscription Management repositories.
Last metadata expiration check: 1:23:32 ago on Sat 11 Jun 2022 06:37:25.
No match for argument: python-concentration
Error: Unable to find a match: python-concentration

Although this is a module released on PyPi package, but it still cannot be packaged into an RPM package. The good news is that you can package it into an RPM package using ​​pyp2rpm​​ in a relatively simple process.

First you need to set up two directories:

$ mkdir rpmbuild
$ cd rpmbuild && mkdir SPECS

Install like this ​​pyp2rpm​​:

$ sudo dnf install pyp2rpm

1. Generate spec file

The basis of an RPM package is a spec file. This file contains all the information you need to create this package, such as required dependencies, application version numbers, installed files and other information. When pointing to a Python module, ​​pyp2rpm​​ will build a spec file for it, which you can use to create RPM packages.

The following takes ​​python-concentration​​ as an example to demonstrate how to build a spec file:

$ pyp2rpm concentration > ~/rpmbuild/SPECS/concentration.spec

The following is the file it generates:

# Created by pyp2rpm-3.3.8
%global pypi_name concentration
%global pypi_version 1.1.5
Name: python-%{pypi_name}
Version:%{pypi_version}
Release:1%{?dist}
Summary:Get work done when you need to, goof off when you don't
License:None
URL:None
Source0:%{pypi_source}
BuildArch:noarch
BuildRequires:python3-devel
BuildRequires:python3dist(setuptools)
%description
Concentration [![PyPI version]( [![Test Status]( [![Lint Status]( [![codecov](
%package -n python3-%{pypi_name}
Summary:%{summary}
%{?python_provide:%python_provide python3-%{pypi_name}}
Requires: (python3dist(hug) >= 2.6.1 with python3dist(hug) < 3~~)
Requires: python3dist(setuptools)
%description -n python3-%{pypi_name}
Concentration [![PyPI version]( [![Test Status]( [![Lint Status]( [![codecov](
%prep
%autosetup -n %{pypi_name}-%{pypi_version}
%build
%py3_build
%install
%py3_install
%files -n python3-%{pypi_name}
%license LICENSE
%doc README.md
%{_bindir}/concentration
%{python3_sitelib}/%{pypi_name}
%{python3_sitelib}/%{pypi_name}-%{pypi_version}-py%{python3_version}.egg-info
%changelog
*- 1.1.5-1
- Initial package.

2. Run rpmlint

To ensure that the spec file complies with the standard, you need to use the ​​rpmlint​​ command on the file:

$ rpmlint ~/rpmbuild/SPEC/concentration.spec
error: bad date in %changelog: - 1.1.5-1
0 packages and 1 specfiles checked; 0 errors, 0 warnings.

Looks like the update log (​​%changelog​​) needs to record the date.

%changelog
* Sat Jun 11 2022 Tux <tux@example.com> - 1.1.5-1

Run again​​rpmint​​:

$ rpmlint ~/rpmbuild/SPEC/concentration.spec
0 packages and 1 specfiles checked; 0 errors, 0 warnings.

Success!

3. Download the source code

You need to download the packaged code to further build the RPM package. A simple way is to parse your spec file to get the URL of the source code.

First, install ​​spectool​​ through ​​dnf​​​:

$ sudo dnf install spectool

然后通过 ​​spectool​​ 来下载源码：

$ cd ~/rpmbuild
$ spectool -g -R SPEC/concentration.spec
Downloading: https://files.pythonhosted.org/...concentration-1.1.5.tar.gz
 6.0 KiB / 6.0 KiB[=====================================]
Downloaded: concentration-1.1.5.tar.gz

这样就创建了一个 ​​SOURCES​​ 目录并将源码放入其中。

4、构建源软件包

现在你已经验证过 spec 文件了，接下来就可以通过 ​​rpmbuild​​​ 构建源软件包了。如果你还没有安装 ​​rpmbuild​​​，你也可以通过 ​​dnf​​​ 安装 ​​rpm-build​​​ 包（或者在使用 ​​rpmbuild​​ 命令时根据终端的的提示进行安装）。

参数 ​​-bs​​ 表示构建源软件包。添加这个参数会产生一个 src.rpm 文件，这是一个用于为特定架构重新构建的通用包：

$ rpmbuild -bs SPECS/concentration.spec
Wrote: ~/rpmbuild/SRPMS/python-concentration-1.1.5-1.el9.src.rpm

为你的系统构建一个可安装的 RPM 文件：

$ rpmbuild –rebuild SRPMS/python-concentration-1.1.5-1.el9.src.rpm
error: Failed build dependencies:
python3-devel is needed by python-concentration-1.1.5-1.el9.noarch

看起来这个包需要安装 Python 的开发库才能继续构建。安装它们以继续构建。这一次，构建成功了，并且渲染了更多的输出（为了清楚起见，我在这里简略了输出）：

$ sudo dnf install python3-devel -y
$ rpmbuild –rebuild SRPMS/python-concentration-1.1.5-1.el9.src.rpm
[...]
Executing(--clean): /bin/sh -e /var/tmp/rpm-tmp.TYA7l2
+ umask 022
+ cd /home/bogus/rpmbuild/BUILD
+ rm -rf concentration-1.1.5
+ RPM_EC=0
++ jobs -p
+ exit 0

你的 RPM 包现在已经构建在 ​​RPMS​​​ 子目录下，像平常一样使用 ​​dnf​​ 安装它。

$ sudo dnf install RPMS/noarch/python3-concentration*rpm

为什么不使用 PyPi？

通常情况下我们并不需要将 Python 模块打包成 RPM 包。通过 PyPi 来安装模块也是可以接受的，但是 PyPi 会安装额外的包管理器对你的模块进行检查和更新。当你使用 ​​dnf​​​ 来安装 RPM 包时，你在安装完成时就能够获取到完整的安装列表。有了 ​​pyp2rpm​​ 之后，这个过程就变得快速、简单且自动化了。

The above is the detailed content of Four steps to package a new Python module. For more information, please follow other related articles on the PHP Chinese website!