How shhhivamm/studyready works
StudyReady is a CBSE question-paper generator. Its main workflows are paper ingestion (admin request → CBSE discovery and download → vision extraction and embeddings → stored questions) and paper generation (request → question selection → LLM formatting → persisted paper → PDF/DOCX download). The graph includes API search and administration alongside these workflows. Edges reflect the sampled source, its indexed references, or README documentation; unsampled subsystem details are not inferred.
Main entry points: papers.py Paper routes · paper_extraction.py Extraction workflow · models.py PostgreSQL / pgvector · main.py FastAPI app
Components 26
API
- FastAPI app
Backend/app/main.py - Request dependencies
Backend/app/api/deps.py - Admin routes
Backend/app/api/routes/admin.py - Paper routes
Backend/app/api/routes/papers.py - Question routes
Backend/app/api/routes/questions.py - Legacy paper API
Backend/services/api.py - Legacy paper lookup
Backend/services/get_paper.py
Paper ingestion
- Extraction workflow
Backend/app/services/extraction/paper_extraction.py - CBSE scraper
Backend/app/services/papers/cbse_scraper.py - PDF downloader
Backend/app/services/papers/downloader.py - Vision extraction
Backend/app/services/extraction/gemini_vision.py
Retrieval and generation
- Embedding service
Backend/app/services/embeddings/gemini_embeddings.py - Question search
Backend/app/services/retrieval/search.py - Question selection
Backend/app/services/retrieval/selector.py - Selection strategies
Backend/app/services/retrieval/strategies.py - Paper generation
Backend/app/services/generation/paper_generator.py - Blueprint extraction
Backend/app/services/papers/blueprint_extractor.py
Data and export
- PostgreSQL / pgvector
Backend/app/database/models.py - Database sessions
Backend/app/database/connection.py - Data repository
Backend/app/database/repository.py - PDF export
Backend/app/services/export/pdf.py - DOCX export
Backend/app/services/export/docx.py - Legacy file handling
Backend/services/files.py
Other components
- API client
- CBSE website
- OpenRouter models
Connections 32
- API client → FastAPI app: sends requests
Backend/app/main.py - FastAPI app → Admin routes: registers routes
Backend/app/main.py - FastAPI app → Paper routes: registers routes
Backend/app/main.py - FastAPI app → Question routes: registers routes
Backend/app/main.py - Admin routes → Extraction workflow: starts extraction
Backend/app/api/routes/admin.py - Paper routes → Question selection: selects questions
Backend/app/api/routes/papers.py - Paper routes → Selection strategies: applies strategies
Backend/app/api/routes/papers.py - Paper routes → Paper generation: formats paper
Backend/app/api/routes/papers.py - Paper routes → Blueprint extraction: extracts blueprint
Backend/app/api/routes/papers.py - Paper routes → PDF export: creates PDF
Backend/app/api/routes/papers.py - Paper routes → DOCX export: exports DOCX
README.md - Question routes → Question search: searches questions
Backend/app/api/routes/questions.py - Extraction workflow → CBSE scraper: finds source papers
Backend/app/services/extraction/paper_extraction.py - Extraction workflow → PDF downloader: downloads PDFs
Backend/app/services/extraction/paper_extraction.py - Extraction workflow → Vision extraction: extracts questions
Backend/app/services/extraction/paper_extraction.py - Extraction workflow → Embedding service: embeds questions
Backend/app/services/extraction/paper_extraction.py - Extraction workflow → PostgreSQL / pgvector: stores questions
Backend/app/services/extraction/paper_extraction.py - CBSE scraper → CBSE website: scrapes papers
README.md - PDF downloader → CBSE website: downloads PDFs
README.md - Vision extraction → OpenRouter models: requests extraction
README.md - Paper generation → OpenRouter models: requests formatting
README.md - Question search → Embedding service: embeds query
Backend/app/services/retrieval/search.py - Question search → PostgreSQL / pgvector: queries vectors
Backend/app/services/retrieval/search.py - Question selection → PostgreSQL / pgvector: uses question records
Backend/app/services/retrieval/selector.py - Selection strategies → PostgreSQL / pgvector: uses question records
Backend/app/services/retrieval/strategies.py - Paper generation → PostgreSQL / pgvector: uses paper records
Backend/app/services/generation/paper_generator.py - Paper routes → PostgreSQL / pgvector: reads and saves papers
Backend/app/api/routes/papers.py - Request dependencies → Database sessions: provides sessions
Backend/app/api/deps.py - Database sessions → PostgreSQL / pgvector: configures ORM
Backend/app/database/models.py - Legacy paper API → Legacy paper lookup: looks up papers
Backend/services/api.py - Legacy paper API → Legacy file handling: serves files
Backend/services/api.py - Legacy paper lookup → Legacy file handling: uses file handling
Backend/services/get_paper.py