Skip to content

Repo hardening: fix install instructions, dead imports, hygiene#1

Open
cognis-digital wants to merge 3 commits into
mainfrom
cognis-audit/repo-hardening
Open

Repo hardening: fix install instructions, dead imports, hygiene#1
cognis-digital wants to merge 3 commits into
mainfrom
cognis-audit/repo-hardening

Conversation

@cognis-digital

@cognis-digital cognis-digital commented Jun 12, 2026

Copy link
Copy Markdown
Owner

This PR applies a few small, mechanically-verified hardening fixes found by an automated audit of the Cognis suite:

  • fix 2 broken pip install line(s) in README (package is not on PyPI; use the working git+https install)
  • remove 4 unused import(s) (ruff F401/F811)

Each change is deterministic; all touched Python files were confirmed to still compile (py_compile) before this PR was opened.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your first PR! 🚀 A maintainer will review under the collaboration-pull model (see CONTRIBUTING.md).

@cognis-digital cognis-digital force-pushed the cognis-audit/repo-hardening branch from 1e3499d to 1cfd95f Compare June 12, 2026 22:00
…rehensive cross-platform install scripts

- README opens with a plain-language "What is this?" overview
- comprehensive Install section + install.sh / install.ps1 (pipx / uv / pip git+https / source)
- verified build-out: real test + CLI audit embedded (README Verification + AUDIT.md)
@cognis-digital cognis-digital force-pushed the cognis-audit/repo-hardening branch from cad955f to 1b4e6c7 Compare June 13, 2026 12:42
Cognis Digital added 2 commits June 13, 2026 09:17
- core.py RagIndex.from_dict: validate required fields (chunks/idf/chunk_size/overlap)
  are present before unpacking; surface KeyError/TypeError on malformed chunk
  records as ValueError with a descriptive message instead of a bare exception
- core.py load_index: catch json.JSONDecodeError and re-raise as ValueError so
  CLI and callers get a clean error message instead of a raw traceback
- cli.py: validate --top-k is >= 1 for search and ask subcommands; return exit 2
  on bad value instead of silently returning empty results
- mcp_server.py: fix module-level import of non-existent scan/to_json symbols
  (ImportError on import); replace with correct ragkit.core API and add error
  handling in the MCP tool handler
- tests: add 7 new HardeningTests covering corrupt JSON, missing fields, malformed
  chunk records, top-k validation, empty-doc index, and CLI exit codes
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