Packaging SideGDB as an application

Warning

Packaging is officially supported for v0.3.0-alpha.3 upwards. v0.2.x is NOT supported.

Warning

Packaging is broken on v0.3.0-alpha.2. It's not recommended to run PyInstaller on this version as it's prone to errors.

Important

Make sure you have properly set up the project before reading this guide.

SideGDB uses PyInstaller to package the project into a one-folder executable. Make sure to install it either via pip or through your distro's package manager:

Python package	Debian (apt)	Arch Linux (pacman/AUR)	Fedora (dnf/yum) (most likely dnf)
PyInstaller	pyinstaller	pyinstaller [AUR]	python3-pyinstaller [COPR]

Tip

If you're using KDE Plasma (or any DE that renders with Qt) and you want SideGDB to also use your system theme, you should NOT use a virtual environment and install all the required dependencies on your system to make PyInstaller use the system libraries' hooks instead of your venv's.

Run:

pyinstaller sidegdb.spec

To start packaging.

If everything works fine, you should find your executable under dist/sidegdb. Run it and enjoy! :)

Note

You don't need to have these libraries installed if you want to run the executable, as all libraries are bundled with the executable.