Skip to content

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

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

Repo hardening: fix install instructions, dead imports, hygiene#1
cognis-digital wants to merge 5 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 5 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.

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

@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 9699f71 to 61b7e67 Compare June 12, 2026 21:47
Cognis Digital added 4 commits June 13, 2026 03:47
…verview and install scripts

The --format option was defined only on the top-level parser, so passing it
after a subcommand (e.g. validate --format json) triggered an argparse error
and caused two smoke tests to fail. Added --format to each subparser (validate,
crosswalk, detect) so the flag works in the natural position users expect.

Also adds a plain-language 'What is this?' section to the README and
comprehensive cross-platform install scripts (install.sh / install.ps1).
- cli._load(): catch FileNotFoundError, UnicodeDecodeError, csv.Error, OSError
  on --table files; print a clear message to stderr and raise SystemExit(2)
- cli._read_codes(): catch FileNotFoundError, UnicodeDecodeError, OSError on
  --input files; same clean-exit behaviour
- cli.main(): wrap dispatch in try/except; re-raise SystemExit, handle
  KeyboardInterrupt gracefully, catch unexpected exceptions without traceback
- Add import csv (needed for csv.Error guard)
- Add _die() helper for callers that return 2 directly
- tests/test_hardening.py: 7 new tests covering missing files (exit 2),
  invalid UTF-8 input and table files (exit 2), unknown --to target (exit 2),
  and comment-only input file (exit 2)
… mcp_server imports, add ruff config, and expand edge-case test coverage
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