todo-6-cleanup-closeout.md 2.4 KB

Todo 6 Cleanup and Closeout Plan

Status: done

Goal

Clean local generated files from the deliverable surface, align contributor docs with the implemented project, and run final verification.

Scope

This todo covers:

  • .gitignore updates for local-only files.
  • Removing or ignoring temporary .superpowers/ browser-companion files from the deliverable set.
  • Updating AGENTS.md from the old empty-repo guide to the actual FastAPI/uv project.
  • Final test/import/help verification.
  • Final docs/plans/todos.md status update.

This todo does not cover:

  • New runtime behavior.
  • New UI features.
  • Live LLM network calls.
  • Creating commits unless explicitly requested.

Files

  • Modify: .gitignore
  • Modify or create: AGENTS.md
  • Modify: docs/plans/todos.md
  • Modify: docs/plans/todo-6-cleanup-closeout.md
  • Do not modify production code unless final verification exposes a bug.

Steps

  1. Inspect .gitignore and current git status.
  2. Add local-only ignores:
    • .env
    • .venv/
    • .pytest_cache/
    • .superpowers/
    • __pycache__/
  3. Update AGENTS.md to describe the actual repo:
    • src/agent_lab/ package layout.
    • tests/.
    • scripts/ws_smoke.py.
    • docs/plans/.
    • uv commands.
    • FastAPI/WebSocket and pydantic-settings conventions.
  4. Run verification:

    uv run pytest
    uv run python -c "from agent_lab.main import app; print(app.title)"
    uv run python scripts/ws_smoke.py --help
    git status --porcelain=v2 --branch
    
  5. Update docs/plans/todos.md and this file with results.

Verification

Completed result:

  • .gitignore now ignores .env, .venv/, .pytest_cache/, and .superpowers/; __pycache__/ was already covered.
  • AGENTS.md was created for the implemented FastAPI, WebSocket, uv, DDD, and pydantic-settings project shape.
  • uv run pytest passed: 10 passed, 1 warning.
  • uv run python -c "from agent_lab.main import app; print(app.title)" passed and printed Agent Lab.
  • uv run python scripts/ws_smoke.py --help passed and showed the expected CLI options.
  • git status --porcelain=v2 --branch no longer lists .superpowers/, .venv/, .pytest_cache/, or .env.

Notes:

  • The remaining warning is the existing FastAPI/Starlette TestClient deprecation warning for the installed httpx integration.
  • The two uv run python ... verification commands initially hit sandbox permission limits while reading ~/.cache/uv; they passed after rerunning with approval.