Repo hardening: fix install instructions, dead imports, hygiene#2
Open
cognis-digital wants to merge 4 commits into
Open
Repo hardening: fix install instructions, dead imports, hygiene#2cognis-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 3 unused import(s) (ruff F401/F811)
ac50132 to
cb01025
Compare
added 3 commits
June 13, 2026 03:52
- Insert "What is this?" section in README for non-technical readers - Add comprehensive Install section covering pipx/uv/pip/source installs - Generate cross-platform install.sh (Linux/macOS) and install.ps1 (Windows) - Add layman.md with plain-language description of the tool
- crack_hash: reject empty/non-hex digests; guard max_candidates < 1 - CrackQ.submit: validate owner (non-empty), priority (int), algorithm - CrackQ.load_wordlist: raise FileNotFoundError for missing path - AuditLog._last_hash / entries: raise AuditError on malformed JSON lines instead of letting json.JSONDecodeError propagate uncaught - cli._load_words / _gather_hashes: check file exists before open, emit clear FileNotFoundError with path - cli.main: catch PermissionError, OSError/IOError, json.JSONDecodeError, and AuditError — all map to exit 2 with a readable stderr message - cli.build_parser: fix pre-existing E501 line-length violations - mcp_server: fix pre-existing E501 line-length violation - tests: add 18 new edge-case tests covering the above paths (30 total, all green; existing 12 unchanged)
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.