Repo hardening: fix install instructions, dead imports, hygiene#1
Open
cognis-digital wants to merge 4 commits into
Open
Repo hardening: fix install instructions, dead imports, hygiene#1cognis-digital wants to merge 4 commits into
cognis-digital wants to merge 4 commits into
Conversation
- 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)
f31e3f9 to
5e2cbcf
Compare
added 3 commits
June 13, 2026 03:43
…; add plain-language overview and install instructions The test had a misplaced closing brace: old was missing one } and new had one extra }, making both strings invalid JSON (JSONDecodeError). Fixed by correcting brace counts to match the intended nested OpenAPI structure (11 opens/closes for old, 10 for new). All 19 tests now pass. Added layman.md overview, updated README with What is this? and Install sections, and added install.sh / install.ps1 scripts.
- core.py: remove unused variable `i` (ruff F841); add explicit guards in diff_files() for None, non-str, whitespace-only, and unknown fmt inputs — each raises ValueError with a clear message instead of a cryptic downstream exception - mcp_server.py: fix broken top-level import (scan/to_json never existed in core); rewrite serve() to use diff_files() + to_dict(), with per-call ValueError/JSONDecodeError handling that returns a JSON error payload rather than crashing the MCP tool - cli.py: widen file-read exception handler to include UnicodeDecodeError so binary/non-UTF-8 files exit 2 with a clear message - tests: add 7 new tests covering missing file (exit 2), malformed JSON (exit 2), empty inputs, non-string inputs, unknown fmt, and mcp_server importability; all 26 tests green
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.
This PR applies a few small, mechanically-verified hardening fixes found by an automated audit of the Cognis suite:
pip installline(s) in README (package is not on PyPI; use the working git+https install)Each change is deterministic; all touched Python files were confirmed to still compile (
py_compile) before this PR was opened.