1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
|
[[setup-py]]
=== setup.py (Python3, CLI)
Here is an example of creating a simple Debian package from a Python3 CLI program using *setup.py* as its build system.
Let's assume its upstream tarball to be *debhello-1.1.tar.gz*.
This type of source is meant to be installed as a non-system file as:
----
$ tar -xzmf debhello-1.1.tar.gz
$ cd debhello-1.1
$ python3 setup.py install
----
Debian packaging requires changing the last line to ``*python3 setup.py install --install-layout=deb*'' to install files into the target system image location. This issue is automatically addressed when using the *dh* command for Debian packaging.
Let's get the source and make the Debian package.
.Download *debhello-1.1.tar.gz*
----
include::../debhello-1.1-pkg1/step000.slog[]
----
Here, the *hello* script and its associated *hello_py* module are as follows.
.*hello* (v=1.1)
----
include::../debhello-1.1-pkg1/step101.slog[]
----
.*hello_py/\_\_init__.py* (v=1.1)
----
include::../debhello-1.1-pkg1/step102.slog[]
----
These are packaged using the Python https://docs.python.org/3.4/library/distutils.html#module-distutils[distutils] with the *setup.py* and *MANIFEST.in* files.
.*setup.py* (v=1.1)
----
include::../debhello-1.1-pkg1/step103.slog[]
----
.*MANIFEST.in* (v=1.1)
----
include::../debhello-1.1-pkg1/step104.slog[]
----
TIP: Many modern Python packages are distributed using https://setuptools.pypa.io/en/latest/setuptools.html[setuptools]. Since setuptools is an enhanced alternative to distutils, this example is useful for them.
Let's package this with the *debmake* command. Here, the *-b\':py3'* option is used to specify the generated binary package containing Python3 script and module files.
----
sys::[head -n12 ../debhello-1.1-pkg1/step200.slog]
...
----
Let's inspect the notable template files generated.
.*debian/rules* (template file, v=1.1):
----
include::../debhello-1.1-pkg1/step202.slog[]
----
This is essentially the standard *debian/rules* file with the *dh* command.
The use of the ``*--with python3*'' option invokes *dh_python3* to calculate Python dependencies, add maintainer scripts to byte compiled files, etc. See *dh_python3*(1).
The use of the ``*--buildsystem=pybuild*'' option invokes various build systems for requested Python versions in order to build modules and extensions. See *pybuild*(1).
.*debian/control* (template file, v=1.1):
----
include::../debhello-1.1-pkg1/step203.slog[]
----
Since this is the Python3 package, the *debmake* command sets ``*Architecture: all*'' and ``*Multi-Arch: foreign*''. Also, it sets required *substvar* parameters as ``*Depends: $\{python3:Depends}, $\{misc:Depends}*''. These are explained in <<basics>>.
Let's make this Debian package better as the maintainer.
.*debian/rules* (maintainer version, v=1.1):
----
include::../debhello-1.1-pkg1/step301.slog[]
----
.*debian/control* (maintainer version, v=1.1):
----
include::../debhello-1.1-pkg1/step302.slog[]
----
The *hello* command does not come with the upstream-provided manpage; let's add it as the maintainer.
.*debian/manpages* etc. (maintainer version, v=1.1):
----
include::../debhello-1.1-pkg1/step303.slog[]
----
There are several other template files under the *debian/* directory. These also need to be updated.
The rest of the packaging activities are practically the same as the ones in <<makefile-sh>>.
.Template files under *debian/*. (v=1.1):
----
include::../debhello-1.1-pkg1/step400.slog[]
----
Here is the generated dependency list of *debhello_1.1-1_all.deb*.
.The generated dependency list of *debhello_1.1-1_all.deb*:
----
include::../debhello-1.1-pkg1/step702.slog[]
----
|