# KeyTub
# ======
#
# Application version: 260824.0003
# Windows release version: 260824.0003
# Release status: Production
# Application type: Cross-platform PySide6 Qt Widgets desktop app
# Supported operating systems:
# - Windows 10 version 1809 or newer (x86-64)
# - Windows 11 (x86-64)
# - Ubuntu/Kubuntu 22.04 LTS or newer (x86-64)
# - Ubuntu/Kubuntu 24.04 LTS or newer (ARM64)
# Python requirement: Python 3.10 or newer (3.11+ recommended)
# Entry point: main.py
#
# Production versioning
# ---------------------
# KeyTub uses date/build versioning: YYMMDD.BUILD_NO
# - YYMMDD: release date
# - BUILD_NO: zero-padded release build number
#
# Key features
# ------------
# - Hierarchical category-based data storage
# - Notes, events, deadlines, completion status, and overdue highlighting
# - SQLCipher database with create, update, delete, search, backup, and reset
# - Transactional CSV import plus visible-row and full-data CSV export
# - SQLCipher encryption for the complete database, journal, and WAL content
# - Password-based locking and unlocking
# - Persistent database health and lock-status footer indicator
# - Cross-platform per-user database storage
#
# CSV exports contain decrypted values, including values masked in the grid.
# Store exported CSV files securely because they are not encrypted.
#
# Database locations
# ------------------
# Windows:
#   %LOCALAPPDATA%\keytub\keytub.db
#
# Ubuntu/Kubuntu:
#   $XDG_DATA_HOME/keytub/keytub.db
#   or ~/.local/share/keytub/keytub.db when XDG_DATA_HOME is not set
#
# Override the database directory with KEYTUB_DATA_DIR:
#
# Windows PowerShell:
#   $env:KEYTUB_DATA_DIR = "C:\path\to\keytub-data"
#
# Ubuntu/Kubuntu:
#   export KEYTUB_DATA_DIR="$HOME/path/to/keytub-data"
#
# Windows installation
# --------------------
# 1. Install 64-bit Python 3.10 or newer from:
#      https://www.python.org/downloads/windows/
#    Enable "Add Python to PATH" during installation.
#
# 2. Open PowerShell in the KeyTub project directory.
#
# 3. Create a virtual environment:
#      python -m venv .venv
#
# 4. Activate it:
#      .\.venv\Scripts\Activate.ps1
#
#    If PowerShell blocks activation, allow local scripts for your user:
#      Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
#
# 5. Upgrade pip:
#      python -m pip install --upgrade pip
#
# 6. Install KeyTub dependencies:
#      python -m pip install -r requirements.txt
#
# 7. Start KeyTub:
#      python main.py
#
# Windows desktop shortcut
# ------------------------
# A shortcut can launch KeyTub without first activating the virtual
# environment. Replace C:\path\to\python_keytub with the real project path.
#
# 1. Right-click the Windows desktop and select New > Shortcut.
#
# 2. Enter the following shortcut target on one line:
#      "C:\path\to\python_keytub\.venv\Scripts\pythonw.exe" "C:\path\to\python_keytub\main.py"
#
#    pythonw.exe launches the graphical app without opening a console
#    window. Use python.exe instead when troubleshooting startup errors.
#
# 3. Select Next, enter KeyTub as the shortcut name, and select Finish.
#
# 4. Right-click the new shortcut and select Properties.
#
# 5. Set "Start in" to the project directory:
#      C:\path\to\python_keytub
#
# 6. Optional: use Change Icon to select a KeyTub .ico file if one is
#    added to the project later.
#
# Ubuntu/Kubuntu installation
# ---------------------------
# These instructions target a graphical Ubuntu/Kubuntu desktop session,
# version 22.04 LTS or newer on x86-64. ARM64 should use 24.04 LTS or newer.
#
# 1. Open a terminal and install Python, venv support, pip, and common
#    Qt/XCB runtime libraries:
#      sudo apt update
#      sudo apt install -y python3 python3-venv python3-pip \
#          libegl1 libgl1 libxcb-cursor0 libxkbcommon-x11-0
#
#    A normal Ubuntu/Kubuntu desktop usually already includes most Qt
#    runtime libraries. The packages above cover common minimal installs.
#
# 2. Change to the KeyTub project directory:
#      cd /path/to/python_keytub
#
# 3. Create a virtual environment:
#      python3 -m venv .venv
#
# 4. Activate it:
#      source .venv/bin/activate
#
# 5. Upgrade pip:
#      python -m pip install --upgrade pip
#
# 6. Install KeyTub dependencies:
#      python -m pip install -r requirements.txt
#
# 7. Start KeyTub from a graphical desktop session:
#      python main.py
#
# Ubuntu/Kubuntu application launcher and desktop shortcut
# --------------------------------------------------------
# A .desktop launcher can start KeyTub without first activating the
# virtual environment. Replace /absolute/path/to/python_keytub with the
# real absolute project path. Do not use ~ inside Exec or Path.
#
# 1. Create the local applications directory if needed:
#      mkdir -p ~/.local/share/applications
#
# 2. Create ~/.local/share/applications/keytub.desktop containing:
#
#      [Desktop Entry]
#      Version=1.0
#      Type=Application
#      Name=KeyTub
#      Comment=Encrypted hierarchical data store
#      Exec=/absolute/path/to/python_keytub/.venv/bin/python /absolute/path/to/python_keytub/main.py
#      Path=/absolute/path/to/python_keytub
#      Terminal=false
#      Categories=Utility;
#
# 3. Make the launcher executable:
#      chmod +x ~/.local/share/applications/keytub.desktop
#
# 4. KeyTub should now appear in the desktop application menu. Log out
#    and back in if the desktop menu does not refresh immediately.
#
# 5. To also place a shortcut on the desktop:
#      cp ~/.local/share/applications/keytub.desktop ~/Desktop/
#      chmod +x ~/Desktop/keytub.desktop
#
# 6. On Ubuntu GNOME, right-click the desktop icon and choose
#    "Allow Launching" if prompted. On Kubuntu, approve the launcher when
#    Plasma asks whether the file should be trusted.
#
# 7. Optional: add this line to the [Desktop Entry] section when a PNG or
#    SVG icon is available:
#      Icon=/absolute/path/to/python_keytub/ui/keytub.png
#
# Updating an existing installation
# ---------------------------------
# Activate the existing virtual environment, then run:
#   python -m pip install --upgrade -r requirements.txt
#
# Windows standalone publishing
# -----------------------------
# KeyTub includes pysidedeploy.spec for producing a compiled standalone
# Windows folder with pyside6-deploy and Nuitka.
#
# Use the 64-bit python.org distribution of Python 3.13 rather than the
# Microsoft Store Python package. The Store package protects and virtualizes
# files that Nuitka needs during compilation.
#
# 1. Create a separate publishing environment:
#      python -m venv .venv-publish
#
# 2. Install the application and compiler dependencies:
#      .\.venv-publish\Scripts\python.exe -m pip install \
#          -r requirements.txt Nuitka==4.1.2
#
# 3. Build, verify, smoke-test, and archive the standalone package:
#      powershell -ExecutionPolicy Bypass -File .\build_publish.ps1
#
#    To reuse the currently installed publishing dependencies:
#      powershell -ExecutionPolicy Bypass -File .\build_publish.ps1 \
#          -SkipDependencyInstall
#
# Nuitka may download its supported compiler tools on the first build.
# The script automatically synchronizes deployment metadata with version.py.
# The completed package and versioned ZIP are written to the publish folder.
#
# Distribute the whole KeyTub.dist folder. KeyTub.exe depends on the DLLs
# and Qt plugin folders beside it. The live keytub.db database is not included.
#
# The generated executable is not digitally signed by default. Windows
# SmartScreen may warn on another computer until a trusted code-signing
# certificate is applied to KeyTub.exe.
#
# Notes
# -----
# - SQLCipher is supplied by the self-contained sqlcipher3 wheel; no
#   separate SQLite or SQLCipher installation is normally required.
# - PySide6 wheels include the Qt binaries, so a separate Qt SDK is not
#   required.
# - Do not copy or move the .venv directory between computers. Recreate
#   it using the instructions above.
# - Back up the database from File > Backup Database before upgrades.
#
# Python dependencies
# -------------------
# Qt 6.12 is the final Qt feature line that supports Windows 10.
# Keep this upper bound while Windows 10 remains a supported target.
PySide6>=6.8,<6.13
cryptography>=44
sqlcipher3==0.6.2
