Repository navigation
The README, the packaging and the env file say what the code needs - #5
Merged
Merged
Conversation
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.
Goal
A visitor who follows the README gets requirements, setup steps and an env file that match what the code reads and runs.
Changes
QUICK_START.md, aspyproject.tomlrequires.pydantic-ai>=2.69.0inpyproject.tomlandrequirements.txt;html2textandbeautifulsoup4, which the crawlers import, are declared.tests/ragas_eval.pyreads the OpenRouter endpoint and model fromconfig.py, like the app..env.examplelists every variable the code reads, with the defaults fromconfig.py. The README has a table of them, says how.envand the environment combine, and what a different embedding model requires.docs/RAG_IMPROVEMENTS.mdand the README show the current chunk, rerank and retrieval defaults.setup.pyprints the same steps.run.pyoffersinteractive,queryandcheck, points database setup toinit_db.pyand the crawler, and prints its usage on-hor--helpanywhere in the arguments.configured_key()inconfig.py, used by every script that reads a key: the app, both crawlers,db_inspect.py,tests/ragas_eval.pyandapi_debug.py.tests/ragas_eval.pyprefers variables exported in the shell over.env.Tests
ruff check .(0.16.1, as in CI) and the offline test suite pass on every commit, on Python 3.11 with pydantic-ai 2.69.0: 110 tests at the tip.tests/test_run.pyrunsrun.pywith--help,-handquery --helpand expects the usage with exit code 0. It runs a lone copy ofrun.py, so a regression stops at an import instead of reaching a model.os.getenv,os.environ.getorconfigured_keyappears in.env.example(21 names).tests/ragas_eval.pyneeds both; it is checked by ruff and by importing it with different values in the shell and in.env.