typetype-development

TypeType Development

Quick Setup

Prerequisites: Python 3.12+, uv package manager

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone + install
git clone <repo> && cd typetype && uv sync

# Run
uv run python main.py

First Files to Read

For a fast mental model of the current project, read these first:

1. main.py
2. src/backend/presentation/bridge.py
3. src/backend/presentation/adapters/text_adapter.py
4. src/backend/application/usecases/load_text_usecase.py
5. src/backend/application/gateways/text_source_gateway.py
6. src/backend/domain/services/typing_service.py

Common Commands

# TESTING
uv run pytest                      # all tests
uv run pytest tests/test_file.py   # single file
uv run pytest -v                  # verbose

# CODE QUALITY
uv run ruff check .               # lint check
uv run ruff format --check .      # format check
uv run ruff format .              # auto format

# LOGGING
TYPETYPE_DEBUG=1 uv run python main.py          # debug enabled
TYPETYPE_LOG_LEVEL=info uv run python main.py  # set level: debug/info/warning/error/none

Pre-Commit Checklist (MUST DO)

Before commit, all must pass locally:

uv run pytest
uv run ruff check .
uv run ruff format --check .

Fix any failure before commit.

Commit Convention

Repository commits follow the Lore Commit Protocol: describe why first, then record constraints, rejected options, confidence, scope risk, and what was verified.

Recommended template:

<intent line: why this change was made>

<body: context, constraints, rationale>

Constraint: <external constraint>
Rejected: <alternative> | <reason>
Confidence: <low|medium|high>
Scope-risk: <narrow|moderate|broad>
Directive: <warning for future modifiers>
Tested: <what was verified>
Not-tested: <known gaps>

Packaging (Nuitka)

uv run python -m ensurepip --upgrade
uv pip install --upgrade nuitka

uv run python -m nuitka main.py \
  --follow-imports \
  --enable-plugin=pyside6 \
  --include-qt-plugins=qml \
  --include-package=RinUI \
  --include-data-dir=RinUI=RinUI \
  --include-data-dir=config=config \
  --output-dir=deployment \
  --quiet \
  --noinclude-qt-translations \
  --standalone \
  --noinclude-dlls=libQt6WebEngine* \
  --include-data-dir=src/qml=src/qml \
  --include-data-dir=resources/texts=resources/texts \
  --include-data-files=resources/images/TypeTypeLogo.png=resources/images/TypeTypeLogo.png \
  --include-data-files=resources/fonts/HarmonyOS_Sans_SC_Regular-subset.ttf=resources/fonts/HarmonyOS_Sans_SC_Regular-subset.ttf \
  --include-data-files=resources/fonts/LXGWWenKai-Regular-subset.ttf=resources/fonts/LXGWWenKai-Regular-subset.ttf \
  --include-data-dir=resources/trainer=resources/trainer \
  --include-data-dir=resources/ziti=resources/ziti