Skip to content

The README, the packaging and the env file say what the code needs - #5

Merged
FaustoS88 merged 13 commits into
developfrom
fix/PSE-001-docs-match-code
Nov 17, 2026
Merged

FaustoS88 merged 13 commits into
developfrom
fix/PSE-001-docs-match-code

Conversation

@FaustoS88

Copy link
Copy Markdown
Owner

Goal

A visitor who follows the README gets requirements, setup steps and an env file that match what the code reads and runs.

Changes

  • Python 3.11+ in the README badge, the prerequisites and QUICK_START.md, as pyproject.toml requires.
  • pydantic-ai>=2.69.0 in pyproject.toml and requirements.txt; html2text and beautifulsoup4, which the crawlers import, are declared.
  • tests/ragas_eval.py reads the OpenRouter endpoint and model from config.py, like the app.
  • .env.example lists every variable the code reads, with the defaults from config.py. The README has a table of them, says how .env and the environment combine, and what a different embedding model requires.
  • docs/RAG_IMPROVEMENTS.md and the README show the current chunk, rerank and retrieval defaults.
  • The Quick Start enters the cloned folder and activates the virtual environment, and setup.py prints the same steps.
  • The README credits Crawl4AI with its text attribution.
  • run.py offers interactive, query and check, points database setup to init_db.py and the crawler, and prints its usage on -h or --help anywhere in the arguments.
  • One placeholder rule for API keys, configured_key() in config.py, used by every script that reads a key: the app, both crawlers, db_inspect.py, tests/ragas_eval.py and api_debug.py.
  • tests/ragas_eval.py prefers 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.
  • New: tests/test_run.py runs run.py with --help, -h and query --help and expects the usage with exit code 0. It runs a lone copy of run.py, so a regression stops at an import instead of reaching a model.
  • Every name read with os.getenv, os.environ.get or configured_key appears in .env.example (21 names).
  • Not covered: no live model calls and no database. tests/ragas_eval.py needs both; it is checked by ruff and by importing it with different values in the shell and in .env.

@FaustoS88
FaustoS88 merged commit 912c1a6 into develop Nov 17, 2026
2 checks passed
@FaustoS88
FaustoS88 deleted the fix/PSE-001-docs-match-code branch November 17, 2026 13:01
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