{"id":65438,"date":"2022-06-30T09:00:53","date_gmt":"2022-06-30T09:00:53","guid":{"rendered":"https:\/\/www.cryptocabaret.com\/?p=65438"},"modified":"2022-06-30T09:00:53","modified_gmt":"2022-06-30T09:00:53","slug":"package-a-new-python-module-in-4-steps","status":"publish","type":"post","link":"https:\/\/www.cryptocabaret.com\/?p=65438","title":{"rendered":"Package a new Python module in 4 steps"},"content":{"rendered":"

Package a new Python module in 4 steps<\/span>
\nSumantro Mukherjee<\/a><\/span>
\nThu, 06\/30\/2022 – 03:00<\/span><\/p>\n

\n
Register<\/a> or Login<\/a> to like<\/div>\n
Register<\/a> or Login<\/a> to like<\/div>\n<\/div>\n
\n

When you install an application, you’re usually installing a package that contains the executable code for an application and important files such as documentation, icons, and so on. On Linux, applications are commonly packaged as RPM or DEB files, and users install them with the dnf<\/code> or apt<\/code> commands, depending on the Linux distribution. However, new Python modules are released virtually every day, so you could easily encounter a module that hasn’t yet been packaged. And that’s exactly why the pyp2rpm<\/code> command exists.<\/p>\n

Recently, I tried to install a module called python-concentration. It didn’t go well:<\/p>\n

\n
$ sudo<\/span> dnf install<\/span> python-concentration
\nUpdating Subscription Management repositories.
\nLast metadata expiration check: 1<\/span>:23<\/span>:32<\/span> ago on Sat 11<\/span> Jun 2022<\/span> 06:37<\/span>:25<\/span>.
\nNo match for<\/span> argument: python-concentration
\nError: Unable to find<\/span> a match: python-concentration<\/div><\/div><\/pre>\n
It\u2019s a PyPi package, but it’s not yet available as an RPM package. The good news is that you can build an RPM yourself with a relatively simple process using pyp2rpm<\/code>.<\/p>\n
You’ll need two directories to get started:<\/p>\n
\n
$ mkdir<\/span> rpmbuild
\n$ cd<\/span> rpmbuild &&<\/span> mkdir<\/span> SPECS<\/div><\/div><\/pre>\n
You’ll also need to install pyp2rpm<\/code>:<\/p>\n
\n$ <\/span>sudo<\/span> dnf install<\/span> pyp2rpm<\/code><\/span><\/pre>\n<\/p>\n
\n
More Python resources<\/div>\n
\n
What is an IDE?<\/a><\/div>\n
Cheat sheet: Python 3.7 for beginners<\/a><\/div>\n
Top Python GUI frameworks<\/a><\/div>\n
Download: 7 essential PyPI libraries<\/a><\/div>\n
Red Hat Developers<\/a><\/div>\n
Latest Python articles<\/a><\/div>\n<\/p><\/div>\n<\/p><\/div>\n
1. Generate the spec file<\/h2>\n
The foundation of any RPM package is a file called the spec file<\/i>. This file contains all the information about how to build the package, which dependencies it needs, the version of the application it provides, what files it installs, and more. When pointed to a Python module, pyp2rpm<\/code> generates a spec file for it, which you can use to build an RPM.<\/p>\n
Using python-concentration as an arbitrary example, here’s how to generate a spec file:<\/p>\n
\n$ <\/span>pyp2rpm concentration ><\/span> ~\/<\/span>rpmbuild\/<\/span>SPECS\/<\/span>concentration.spec<\/code><\/span><\/pre>\n
And here’s the file it generates:<\/p>\n
\n
# Created by pyp2rpm-3.3.8<\/span>
%<\/span>global pypi_name concentration
%<\/span>global pypi_version 1.1.5

\nName: \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 python-%<\/span>{<\/span>pypi_name}<\/span>
\nVersion: \u00a0 \u00a0 \u00a0 \u00a0%<\/span>{<\/span>pypi_version}<\/span>
\nRelease: \u00a0 \u00a0 \u00a0 \u00a01<\/span>%<\/span>{<\/span>?dist}<\/span>
\nSummary: \u00a0 \u00a0 \u00a0 \u00a0Get work done<\/span> when you need to, goof off when you don't

\nLicense: \u00a0 \u00a0 \u00a0 \u00a0None
\nURL: \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0None
\nSource0: \u00a0 \u00a0 \u00a0 \u00a0%{pypi_source}
\nBuildArch: \u00a0 \u00a0 \u00a0noarch

\nBuildRequires: \u00a0python3-devel
\nBuildRequires: \u00a0python3dist(setuptools)

\n%description
\nConcentration [![PyPI version]( [![Test Status]( [![Lint Status]( [![codecov](

\n%package -n \u00a0 \u00a0 python3-%{pypi_name}
\nSummary: \u00a0 \u00a0 \u00a0 \u00a0%{summary}
\n%{?python_provide:%python_provide python3-%{pypi_name}}

\nRequires: \u00a0 \u00a0 \u00a0 (python3dist(hug) >= 2.6.1 with python3dist(hug) \nRequires: \u00a0 \u00a0 \u00a0 python3dist(setuptools)
\n%description -n python3-%{pypi_name}
\nConcentration [![PyPI version]( [![Test Status]( [![Lint Status]( [![codecov](


\n%prep
\n%autosetup -n %{pypi_name}-%{pypi_version}

\n%build
\n%py3_build

\n%install
\n%py3_install

\n%files -n python3-%{pypi_name}
\n%license LICENSE
\n%doc README.md
\n%{_bindir}\/concentration
\n%{python3_sitelib}\/%{pypi_name}
\n%{python3_sitelib}\/%{pypi_name}-%{pypi_version}-py%{python3_version}.egg-info

\n%changelog
\n* \u00a0- 1.1.5-1
\n- Initial package.<\/span><\/div><\/div><\/pre>\n
2. Run rpmlint<\/b><\/h2>\n
To ensure that the spec file is up to standards, run the rpmlint<\/code> command on the file:<\/p>\n
\n
$ rpmlint ~\/<\/span>rpmbuild\/<\/span>SPEC\/<\/span>concentration.spec
\nerror: bad date<\/span> in<\/span> %<\/span>changelog: - 1.1.5-1<\/span>
0<\/span> packages and 1<\/span> specfiles checked; 0<\/span> errors, 0<\/span> warnings.<\/div><\/div><\/pre>\n
It seems the changelog entry requires a date.<\/p>\n
\n
%<\/span>changelog
*<\/span> Sat Jun 11<\/span> 2022<\/span> Tux tux@<\/span>example.com><\/span> - 1.1.5-1<\/span><\/span><\/div><\/div><\/pre>\n
Try rpmlint<\/code> again:<\/p>\n
\n
$ rpmlint ~\/<\/span>rpmbuild\/<\/span>SPEC\/<\/span>concentration.spec
0<\/span> packages and 1<\/span> specfiles checked; 0<\/span> errors, 0<\/span> warnings.<\/div><\/div><\/pre>\n
Success!<\/p>\n
3. Download the source code<\/h2>\n
To build an RPM package, you must download the code you’re packaging up. The easy way to do this is to parse your spec file to find the source code’s location on the Internet.<\/p>\n
First, install the spectool<\/code> command with dnf<\/code>:<\/p>\n
\n$ <\/span>sudo<\/span> dnf install<\/span> spectool<\/code><\/span><\/pre>\n
Then use it to download the source code:<\/p>\n
\n
$ cd<\/span> ~\/<\/span>rpmbuild
\n$ spectool -g<\/span> -R<\/span> SPEC\/<\/span>concentration.spec
\nDownloading: https:\/\/<\/span>files.pythonhosted.org\/<\/span>...concentration-1.1.5.tar.gz
\n\u00a0 \u00a06.0<\/span> KiB \/<\/span> 6.0<\/span> KiB \u00a0 \u00a0[<\/span>=====================================]<\/span>
\nDownloaded: concentration-1.1.5.tar.gz<\/div><\/div><\/pre>\n
This creates a SOURCES directory and places the source code archive into it.<\/p>\n
4. Build the source package<\/h2>\n
Now you have a valid spec file, so it’s time to build the source package with the rpmbuild<\/code> command. If you don’t have rpmbuild<\/code> yet, install the rpm-build package with dnf<\/code> (or accept your terminal’s offer to install that package when you attempt to use the rpmbuild<\/code> command).<\/p>\n
\n
$ cd<\/span> ~\/<\/span>rpmbuild
\n$ spectool -g<\/span> -R<\/span> SPEC\/<\/span>concentration.spec
\nDownloading: https:\/\/<\/span>files.pythonhosted.org\/<\/span>...concentration-1.1.5.tar.gz
\n\u00a0 \u00a06.0<\/span> KiB \/<\/span> 6.0<\/span> KiB \u00a0 \u00a0[<\/span>=====================================]<\/span>
\nDownloaded: concentration-1.1.5.tar.gz<\/div><\/div><\/pre>\n
The -bs<\/code> option stands for build source<\/i>. This option gives you an src.rpm<\/code> file, an all-purpose package that must be rebuilt for a specific architecture.<\/p>\n
Build an installable RPM for your system:<\/p>\n
\n
$ rpmbuild \u2013rebuild SRPMS\/<\/span>python-concentration-1.1.5-1<\/span>.el9.src.rpm
\nerror: Failed build dependencies:
\n\u00a0 \u00a0 \u00a0 \u00a0 python3-devel is needed by python-concentration-1.1.5-1<\/span>.el9.noarch<\/div><\/div><\/pre>\n
It looks like this package requires the development libraries of Python. Install them to continue with the build. This time the build succeeds and renders a lot more output (which I abbreviate here for clarity):<\/p>\n
\n
$ sudo<\/span> dnf install<\/span> python3-devel -y<\/span>
\n$ rpmbuild \u2013rebuild SRPMS\/<\/span>python-concentration-1.1.5-1<\/span>.el9.src.rpm
[<\/span>...]<\/span>
\nExecuting(<\/span>--clean)<\/span>: \/<\/span>bin\/<\/span>sh<\/span> -e<\/span> \/<\/span>var\/<\/span>tmp\/<\/span>rpm-tmp.TYA7l2
\n+ umask<\/span> 022
\n+ cd<\/span> \/<\/span>home\/<\/span>bogus\/<\/span>rpmbuild\/<\/span>BUILD
\n+ rm<\/span> -rf<\/span> concentration-1.1.5
\n+ RPM_EC<\/span>=0<\/span>
\n++ jobs<\/span> -p<\/span>
\n+ exit<\/span> 0<\/span><\/div><\/div><\/pre>\n
Your RPM package has been built in the RPMS subdirectory. Install it as usual with dnf<\/code>:<\/p>\n
\n$ <\/span>sudo<\/span> dnf install<\/span> RPMS\/<\/span>noarch\/<\/span>python3-concentration*<\/span>rpm<\/code><\/span><\/pre>\n
Why not just use PyPi?<\/h2>\n
It’s not absolutely necessary to make a Python module into an RPM. Installing a module with PyPi is also acceptable, but PyPi adds another package manager to your personal list of things to check and update. When you install an RPM using dnf<\/code>, you have a complete listing of what you’ve installed on your system. Thanks to pyp2rpm<\/code>, the process is quick, easy, and automatable.<\/p>\n<\/div>\n
\n
The pyp2rpm command makes it possible to create an RPM package and automate the process.<\/p>\n<\/div>\n
\n
\n
  \"Hands<\/div>\n
Image by: <\/span><\/p>\n
WOCinTech Chat. Modified by Opensource.com. CC BY-SA 4.0<\/p>\n<\/div>\n<\/article>\n<\/div>\n
\n
Python<\/a><\/div>\n<\/p><\/div>\n
What to read next<\/div>\n
\n
How to install pip to manage PyPI packages easily<\/a><\/div>\n<\/p><\/div>\n

\n        \"Creative<\/a>This work is licensed under a Creative Commons Attribution-Share Alike 4.0 International License.<\/div>\n
\n
\n
Register<\/a> or Login<\/a> to post a comment.<\/div>\n<\/p><\/div>\n<\/section>\n
Powered by WPeMatico<\/a><\/small><\/p>\n","protected":false},"excerpt":{"rendered":"
Package a new Python module in 4 steps Sumantro Mukherjee Thu, 06\/30\/2022 – 03:00 Register or Login to like Register or Login to like When you install an application, you’re usually installing a package that contains the executable code for an application and important files such as documentation, icons, and so on. On Linux, applications […]<\/p>\n","protected":false},"author":1,"featured_media":65439,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[307],"tags":[],"class_list":["post-65438","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-open-source"],"_links":{"self":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/posts\/65438","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=65438"}],"version-history":[{"count":0,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/posts\/65438\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=\/wp\/v2\/media\/65439"}],"wp:attachment":[{"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=65438"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=65438"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.cryptocabaret.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=65438"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}