ea99b1e1dd
Narrow down the system packages that we install in dev environments. The rationale is that we get most of the Python dependencies from Poetry, so we don't need to install them from the system as well. The packages that we do need to install are non-Python ones, and this commit adds some that were missing: make, python3-stdeb. Also, we explicitly install the base Qt5 libraries, in order to get the graphics and C++ libraries that we can't get from PyPI.
4.6 KiB
Development environment
Debian/Ubuntu
Install dependencies:
sudo apt install -y podman dh-python make libqt5gui5 \
python3 python3-dev python3-venv python3-pip python3-stdeb
Install poetry (you may need to add ~/.local/bin/ to your PATH first):
python3 -m pip install poetry
Change to the dangerzone folder, and install the poetry dependencies:
poetry install
Build the latest container:
./install/linux/build-image.sh
Run from source tree:
# start a shell in the virtual environment
poetry shell
# run the CLI
./dev_scripts/dangerzone-cli --help
# run the GUI
./dev_scripts/dangerzone
Create a .deb:
./install/linux/build-deb.py
Fedora
Install dependencies:
sudo dnf install -y rpm-build podman python3 python3-pip qt5-qtbase-gui
Install poetry:
python -m pip install poetry
Change to the dangerzone folder, and install the poetry dependencies:
poetry install
Build the latest container:
./install/linux/build-image.sh
Run from source tree:
# start a shell in the virtual environment
poetry shell
# run the CLI
./dev_scripts/dangerzone-cli --help
# run the GUI
./dev_scripts/dangerzone
Create a .rpm:
./install/linux/build-rpm.py
QubesOS
Create a Debian- or Fedora-based standalone VM with at least 8GB of private storage space, and follow the relevant instructions above.
Over time, you may need to increase disk space or prune outdated Docker images if you run into build issues on this VM.
macOS
Install Docker Desktop. Make sure to choose your correct CPU, either Intel Chip or Apple Chip.
Install the latest version of Python 3.10 from python.org, and make sure /Library/Frameworks/Python.framework/Versions/3.10/bin is in your PATH.
Install Python dependencies:
python3 -m pip install poetry
poetry install
Install Homebrew dependencies:
brew install create-dmg
Build the dangerzone container image:
./install/macos/build-image.sh
Run from source tree:
# start a shell in the virtual environment
poetry shell
# run the CLI
./dev_scripts/dangerzone-cli --help
# run the GUI
./dev_scripts/dangerzone
To create an app bundle, use the build_app.py script:
poetry run ./install/macos/build-app.py
If you want to build for distribution, you'll need a codesigning certificate, and then run:
poetry run ./install/macos/build-app.py --with-codesign
The output is in the dist folder.
Windows
Install Docker Desktop.
Install the latest version of Python 3.10 (64-bit) from python.org. Make sure to check the "Add Python 3.10 to PATH" checkbox on the first page of the installer.
Install Microsoft Visual C++ 14.0 or greater. Get it with "Microsoft C++ Build Tools" and make sure to select "Desktop development with C++" when installing.
Install poetry. Open PowerShell, and run:
python -m pip install poetry
Change to the dangerzone folder, and install the poetry dependencies:
poetry install
Build the dangerzone container image:
python .\install\windows\build-image.py
After that you can launch dangerzone during development with:
# start a shell in the virtual environment
poetry shell
# run the CLI
.\dev_scripts\dangerzone-cli.bat --help
# run the GUI
.\dev_scripts\dangerzone.bat
If you want to build the installer
- Go to https://dotnet.microsoft.com/download/dotnet-framework and download and install .NET Framework 3.5 SP1 Runtime. I downloaded
dotnetfx35.exe. - Go to https://wixtoolset.org/releases/ and download and install WiX toolset. I downloaded
wix311.exe. - Add
C:\Program Files (x86)\WiX Toolset v3.11\binto the path.
If you want to sign binaries with Authenticode
You'll need a code signing certificate.
To make a .exe
Open a command prompt, cd into the dangerzone directory, and run:
poetry run python .\setup-windows.py build
In build\exe.win32-3.10\ you will find dangerzone.exe, dangerzone-cli.exe, and all supporting files.
To build the installer
Note that you must have a codesigning certificate installed in order to use the install\windows\build-app.bat script, because it codesigns dangerzone.exe, dangerzone-cli.exe and Dangerzone.msi.
poetry run .\install\windows\build-app.bat
When you're done you will have dist\Dangerzone.msi.