Repository navigation
docs: Correct install guidance and Python type-checking target - #1
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
README-only changes are consistent with the repository structure (linked files/behavior) and the packaging configuration (no required deps; embed extra present).
Pull request overview
Updates the README to accurately describe memory-mini as a small, local reference implementation and to provide installation instructions that work today (via direct Git installs rather than a non-existent PyPI release).
Changes:
- Reframes the project description from broad “What it proves” claims to concrete “What to inspect” bullets linking to the relevant source files.
- Replaces
pip install memory-mini...PyPI instructions with working PEP 508 direct Git install commands for base andembedextra. - Adds an explicit note that there is currently no PyPI release.
File summaries
| File | Description |
|---|---|
| README.md | Aligns project scope language with repository reality and updates install guidance to direct Git installs (base + embed). |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Let mypy select the interpreter version it runs under so dependency stubs match the active environment. The existing CI matrix still checks Python 3.11 and 3.12, preserving minimum-version coverage without changing jobs. Co-Authored-By: Codex <noreply@openai.com>
JustinJLeopard
changed the title
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.
Replace unavailable PyPI installation commands with direct Git installs and describe memory-mini through its actual namespaced SQLite storage, lifecycle, and optional embedding helpers.
Let strict mypy checking use the active Python interpreter. Forcing Python3.11 parsing in a Python3.12 environment prevented mypy from reading the installed NumPy stubs. The existing CI matrix continues checking Python3.11 and3.12, each with and without the embedding extra, preserving minimum-version coverage.
Validation: README local file links and
git diff --checkpass. The final diff changes README.md and removes one mypy configuration line from pyproject.toml; the existing workflow, dependency requirements and runtime code are unchanged. All four Python/extras combinations passed Ruff, mypy and pytest with the existing coverage threshold; CodeQL passed. Both existing push and pull-request CI triggers completed successfully on this head.