We're using spotify's opensurce dh-virtualenv to provide debian packaging and deployment of our Python code inside a virtualenv.
dh-virtualenv is essentially a wrapper or extension around existing debian tooling.
You can find the official page here.
Our goal is to use dh-virtualenv for packaging, symlinks (where we can), configuration files, systemd service installation, and virtualization at deployment.
On your build host, install the build tools (these are only needed on your build host):
sudo apt-get install build-essential debhelper devscripts equivs python3-pip python3-all python3-dev python3-setuptools dh-virtualenv
Install Python depends:
python3 -m pip install mock
This is required, otherwise the tooling will fail when tries to evaluate which tests to run.
From the root directory of this repository run:
dpkg-buildpackage -us -uc -b
If you are found favorable by the packaging gods, you should see some output files at ../wlanpi-webui like this:
...
dpkg-deb: building package 'wlanpi-webui-dbgsym' in '../wlanpi-webui-dbgsym_1.0.2b1_arm64.deb'.
dpkg-deb: building package 'wlanpi-webui' in '../wlanpi-webui_1.0.2b1_arm64.deb'.
dpkg-genbuildinfo --build=binary
dpkg-genchanges --build=binary >../wlanpi-webui_1.0.2b1_arm64.changes
dpkg-genchanges: info: binary-only upload (no source code included)
dpkg-source --after-build .
dpkg-buildpackage: info: binary-only upload (no source included)
(venv) wlanpi@rbpi4b-8gb:[~/dev/wlanpi-webui]: ls .. | grep wlanpi-webui_
wlanpi-webui_1.0.2b1_arm64.buildinfo
wlanpi-webui_1.0.2b1_arm64.changes
wlanpi-webui_1.0.2b1_arm64.deb
If we remove our package, it will leave behind the config file in /etc:
sudo apt remove wlanpi-webui
If we want to clean /etc we should purge:
sudo apt purge wlanpi-webui
wlanpi@rbpi4b-8gb:[~/dev]: sudo apt install ~/dev/wlanpi-webui_1.0.2b1_arm64.deb
If you don't want to satisfy build dependencies:
dpkg-buildpackage -us -uc -b -d
Contains changelog information and sets the version of the package
provides dependencies, package name, and other package meta data.
sets compatibility level for debhelper
this is the build recipe for make
this handles placing our config file in /etc
handles symlinks
dh-virtualenv has an autoscript which handles this for us.
dh-virtualenv has an autoscript which handles this for us.
dh automatically picks up and installs this systemd service
tells dpkg what packages we're interested in
Some OS repositories have packages already.
sudo apt install dh-virtualenv
If not available, you can build it from source:
cd ~
# Install needed packages
sudo apt-get install devscripts python3-virtualenv python3-sphinx \
python3-sphinx-rtd-theme git equivs
# Clone git repository
git clone https://github.com/spotify/dh-virtualenv.git
# Change into working directory
cd dh-virtualenv
# This will install build dependencies
sudo mk-build-deps -ri
# Build the *dh-virtualenv* package
dpkg-buildpackage -us -uc -b
# And finally, install it (you might have to solve some
# dependencies when doing this)
sudo dpkg -i ../dh-virtualenv_<version>.deb