^{This project has been generated using 'A-Python-Template' (APT).}

Metadata

• Name: 'a-umami-dashboard' (AUD).
• Purpose: Display (a) Umami dashboard.
• Format: CLI.
• License:
  • This project's license: GNU General Public License v3.0
  • PySide6: GNU General Public License v3.0

Setup

Dependencies:

• Version: 3.14
• Manager: pip

• Toolset:
  • pyproject.toml
  • venv
  • pre-commit (hooks)
    • ruff
    • mypy
  • python-appimage

Installation:

• Windows
  • cd "C:\Users\{User}\AppData\Local\Programs\Python\Launcher"
  • .\py.exe -3.14 -m venv "{path}/a-umami-dashboard/venv-3.14" _suggested
  • everything below
• Linux
  • python3.14 -m venv {path}/a-umami-dashboard/venv-3.14 _suggested
  • everything below

1. cd {path}/a-umami-dashboard
2. source venv-3.14/bin/activate
3. pip install --upgrade pip
4. pip install .
5. double check with which python (Linux)

Usage:

• project
  • a-umami-dashboard/main.py
    • configured using '.env' file
• local tests
  • none
• local CI
  • pre-commit run --all-files
  • • Files must be first added by git add for pre-commit run to detect.
  • • pre-commit run will install a .venv inside ~/.cache/pre-commit/
• local CD
  • AppImage deployment
  • • refer to AppImage/README

Example

Metrics

AppImage

The App can be built locally (with individual .env), then integrated through the .desktop file. This is a prototype I wrote in 2 days just to develop my skills and see how the AppImage building process looks like firsthand.

_{~300MiB in size is an acceptable sacrifice for running an app with one click of a button}

'AUD' is a CLI application rendering a simple Qt window with buttons.