Skip to content

README: lead with the retrieval + selection pipeline; add CI - #1

Merged
monikagadage merged 1 commit into
mainfrom
readme-and-ci
Sep 2, 2026
Merged

README: lead with the retrieval + selection pipeline; add CI#1
monikagadage merged 1 commit into
mainfrom
readme-and-ci

Conversation

@monikagadage

Copy link
Copy Markdown
Owner
  • Rewrites the README to lead with the engineering — RAG retrieval feeding a
    difficulty- and history-aware selection layer, stdlib-SQLite persistence,
    and a Streamlit UI + headless CLI sharing one core — with a
    design-decisions table. Drops the "AI-powered interview prep tool" framing.
  • Adds .github/workflows/ci.yml: runs the hermetic tests (test_store.py
    • test_selection.py, ~40 tests, pytest-only, no ChromaDB/Groq/network)
      on Python 3.11 and 3.12.
  • tests/test_cli.py now uses pytest.importorskip so it skips cleanly
    when the full app stack isn't installed, and still runs locally under
    uv run pytest (45 tests).

Verified: uv run pytest tests/ → 45 passed; pytest tests/ with pytest
only → 40 passed, 1 skipped.

Reframe the README around the engineering — the RAG retrieval feeding a
difficulty- and history-aware selection layer, stdlib SQLite persistence,
and UI/CLI sharing one core — with a design-decisions table, instead of
opening as 'an AI-powered Java interview prep tool'.

Add .github/workflows/ci.yml running the hermetic test subset (store +
selection, ~40 tests, pytest-only) on Python 3.11/3.12. test_cli.py now
uses pytest.importorskip so it skips cleanly when the full app stack
(chromadb, langchain) isn't installed and still runs locally under
'uv run pytest' (45 tests).
@monikagadage
monikagadage merged commit d79d9a5 into main Sep 2, 2026
2 checks passed
@monikagadage
monikagadage deleted the readme-and-ci branch September 2, 2026 02:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant