How clockworksspheres/eisenban works
Project type and purpose
• This is a desktop “Kanban-style” task‐management application written in Python and Qt (PyQt).
• It contains two parallel code bases: “kanbaru” (upstream, frozen) and “eisenban” (rebranded, under active development).
• Core features: create/manage boards, lists, cards; persistent storage; customizable UI; cross-platform packaging.
File structure
• Top‐level directories:
• src/eisenban – the main application code for the rebranded fork
• src/kanbaru – original codebase, same internal structure
• src/tests – unit tests for core libraries
• Common submodules under each code base:
• ui – Qt .ui definitions, generated Python UI wrappers, controllers
• dialog.py, main.py – entry points for application runtime
• db.py – data‐access layer (likely SQLite)
• eisenban_objects.py / kanbaru_objects.py – domain models (Board, List, Card)
• lib/ – shared helper modules (logging, command runners, environment detection, singleton pattern)
• proto/ – exploratory/prototyping scripts, proof‐of‐concept for signals, resources
• packaging scripts – platform‐specific build scripts and spec files (macOS, Linux, Windows)
README insights
• Purpose: preserve Kanbaru’s functionality, add enhancements in Eisenban.
• Dependencies declared in requirements.txt (PyQt5, SQLite, others).
Main components
a. UI Layer
• Qt Widgets / .ui files
• Controllers in ui/*.py (MainWindow, Dialogs, Settings)
b. Domain Layer
• Domain models in *objects.py (Board, List, Card)
• Business logic in dialog.py, utils.py
c. Data Access Layer
• db.py – CRUD operations on SQLite
• config.py – app settings (file paths, user preferences)
d. Infrastructure & Helpers
• lib/ modules – logging, environment detection, command execution
• proto/ – experimental/prototype code (can be shown as “Research/Prototype” cluster)
e. Packaging/Deployment
• Platform build scripts (eisenbuild.*) & spec files
• Packaging tool (PyInstaller)
• Resources compilation (gen_qrc-*.py, QRC → Python resources)
f. Tests
• src/tests – unit tests exercising lib/ and db modules
Component relationships and interactions
• UI Layer → invokes Domain Layer methods
• Domain Layer → reads/writes via Data Access Layer
• Data Access Layer → persists to SQLite database file
• UI Layer → loads resources via compiled resource module (resources_rc.py)
• Packaging scripts → bundle all code, resources, Qt runtime into standalone executables
• lib/ utilities → injected into Domain & Data Access layers for logging & environment checks
• Tests → import lib/ and db.py to verify core functionality
Architectural patterns and principles
• MVC‐like separation:
• Views (Qt .ui + generated wrappers)
• Controllers (ui/*.py providing event handlers)
• Models (domain objects + data‐access)
• Singletons for application‐wide configuration/logging
Technologies, frameworks, and libraries
• Python 3.x
• PyQt5 (Qt Designer .ui files → pyuic-generated code)
• SQLite (via Python’s sqlite3)
• PyInstaller (onefile and spec scripts)
2. UI components on the left:
– Widgets (.ui files) → Generated UI classes → Controller classes.
3. In the middle, place Domain Models and Utility modules.
5. At the bottom or side, cluster Packaging & Deployment: build scripts, spec files, output executables.
6. At the top or side, cluster Tests and Prototypes (proto/) as separate offshoot modules.