Skip to content

Rewrite README, add MIT LICENSE and .env.example - #4

Merged
matuck40 merged 5 commits into
mainfrom
readme-rewrite
Sep 9, 2026
Merged

matuck40 merged 5 commits into
mainfrom
readme-rewrite

Conversation

@matuck40

@matuck40 matuck40 commented Sep 7, 2026

Copy link
Copy Markdown
Owner

What changed

  • README.md rewritten from scratch in English, with the fixed structure: one-line description, Architecture, Example, Running locally, What is not here, Author. Every statement was checked against the code on main.
  • LICENSE: MIT, Copyright (c) 2026 Lucca Matuck.
  • .env.example: variable names only (OPENAI_API_KEY, DATABASE_URL).

Things to review

  • The README does not mention pgvector: the code ranks chunks in memory with a dot product over a JSON cache. PostgreSQL only stores conversation history.
  • The curl example is marked as illustrative. The local OpenAI key was rejected (401), and the app cannot start without a valid key. alembic upgrade head was run for real and created the tables.
  • "What is not here" lists the honest gaps, including two stale in-code comments (app/main.py header, init_db.py docstring).

🤖 Generated with Claude Code

https://claude.ai/code/session_01QVi7kKzGQhgPKX8sDzTu6i

matuck40 and others added 3 commits September 7, 2026 19:16
README describes only what the code does today: section chunking,
OpenAI embeddings cached in JSON, in-memory dot-product ranking,
gpt-4o-mini answers, conversation history in PostgreSQL via
SQLAlchemy and Alembic. The curl example is marked as illustrative.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QVi7kKzGQhgPKX8sDzTu6i
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QVi7kKzGQhgPKX8sDzTu6i
… and CI

- OpenAI clients are created on first use; embeddings load in the FastAPI lifespan
- Pydantic schemas moved to app/schemas.py; app/models.py keeps only the ORM
- DatabaseService uses context-managed sessions; unused methods and
  load_knowledge_base/chunk_text removed
- alembic/env.py reads DATABASE_URL (app/__init__.py loads .env); init_db.py removed
- .model_dump(), sqlalchemy.orm.declarative_base, timezone-aware UTC helper
- tests/ with fakes for OpenAI and the database; ruff config; GitHub Actions workflow
- README updated to match

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QVi7kKzGQhgPKX8sDzTu6i
matuck40 and others added 2 commits September 8, 2026 13:10
Code cleanup: lazy clients, lifespan, schemas split, tests and CI
@matuck40
matuck40 merged commit a4a5e68 into main Sep 9, 2026
6 checks passed
@matuck40
matuck40 deleted the readme-rewrite branch September 9, 2026 16:57
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