Status Report Tool

A local-first desktop app for capturing notes, curating highlights, and generating status and review documents.

Quick Start

1. Create and activate a Python 3.11+ virtual environment.
2. Install dependencies:
   • pip install -e .[dev]
3. Run the app:
   • python -m status_tool
4. Run tests:
   • pytest

Manual QA

• Sprint 1 exit-gate checklist: docs/SPRINT_1_EXIT_GATE_MANUAL_TEST_PLAN.md

Code Style

• Keep functions short and focused; target under 5 lines when practical.
• Prefer concise parameter lists; target fewer than 3 parameters when practical.
• Group related internal arguments into small request objects when it improves readability.
• Avoid duplication: extract shared logic into helpers instead of copying blocks.
• Preserve behavior while refactoring; favor readability improvements without changing outcomes.
• Organize class members in this order:
  • __init__ and other dunder methods
  • properties
  • public methods
  • protected/private methods