README: lead with the retrieval + selection pipeline; add CI - #1
Merged
Conversation
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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
.github/workflows/ci.yml: runs the hermetic tests (test_store.pytest_selection.py, ~40 tests, pytest-only, no ChromaDB/Groq/network)on Python 3.11 and 3.12.
tests/test_cli.pynow usespytest.importorskipso it skips cleanlywhen 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 pytestonly → 40 passed, 1 skipped.