Workspace Initialization#

The page content is collected only during setup of my own environment which is basically never repeated and included some back and forth. I currently use Ubuntu 24.04 with VS Code and Python 3.12 as default. As a consequence:

  • setup is almost certainly incomplete

  • superfluous steps are also likely

  • it is not considering other OSes, yet

If this works out well for you, let me know. For any updates, just modify yourself or notify me directly for small additions.

Ubuntu installations#

sudo apt-get install tox
sudo apt install python3.12-venv
sudo apt install gettext

Virtual Environment Setup#

Recommended is using dev/setup_venv.sh  but you can also run this manually:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
pip install -e . -r tests/requirements.txt -r dev/requirements.txt -r doc/requirements.txt

Always .venv

Ensure to run all commands always from the virtual environment.

Check Setup#

CI Checks#

ruff check
ruff format --check
basedpyright
./dev/check_license_headers.sh
pytest -rA
tox

Package and Documentation Builds#

python -m build
./dev/build_doc.sh

Open documentation and check the version next to “APPXC” in the top left (verify hatch-vcs is working properly). To serve the HTML pages locally while having your browser as protected ubuntu snap, you may use python3 -m http.server 8000 and open http://127.0.0.1:8000/doc/_build/html/index.html.

Manual Test Cases#

Despite the manual test case runner infrastructure, running any manual test case will verify the GUI is working. The first command is some tool helper, not yet being productive, the second and third are two random manual test cases.

python manual_test.py
python tests/unit/gui/manual_setting_frame.py
python PYTHONPATH=. python tests/acceptance/full_application/manual_user_s0.py

Note the PYTHONPATH=. in the last line which is required to find module imports currently still located in tests.

Optional: VS Code Extensions#

Recommended are:

  • Ruff by Astral Software (Ruff formatting on save and inline issue highlighting)

  • Pylance (for inline highlighting even if final checks are basedpyright)

  • Rewrap Revived by Drew Nutter ([Alt]+[Q] auto wrapping lines)

Journal#

15.06.2025#

Problems with pip after changing from Ubuntu 22.04 to 24.04 (pip needs venv or packages must be installed via apt-get). This topic has two aspects:

v0.0.4.dev4