Repo hardening: fix install instructions, dead imports, hygiene#1
Open
cognis-digital wants to merge 5 commits into
Open
Repo hardening: fix install instructions, dead imports, hygiene#1cognis-digital wants to merge 5 commits into
cognis-digital wants to merge 5 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)
b75c992 to
22ae204
Compare
…-06-13) - README install instructions point at the working git+https path - ran the actual audit: 13 tests passed, 0 parse errors, CLI C:\Python314\python.exe: No module named https - embedded results in README ## Verification and AUDIT.md
- Insert "What is this?" layman section in README.md explaining the tool in non-technical terms - Insert comprehensive Install section with one-liner scripts and all install methods - Write install.sh (POSIX) and install.ps1 (Windows PowerShell) covering pipx/uv/pip/source - Add layman.md source file
- core.py: render_userjs now validates required keys before indexing; render_brave_policy guards the 'settings' key; audit_userjs rejects None text with a clear ValueError; Engine.rank raises ValueError (not KeyError) for unknown profile names. - cli.py: audit command catches UnicodeDecodeError for binary files (exit 2) and adds an explicit file-not-found check with a clear message before attempting open(). - integrations/webhook.py: split compound import (E401); added URL scheme validation (http/https only, exit 2 on bad scheme); warns to stderr on empty stdin payload; skips malformed headers with a warning instead of silently misfiring. - tests/test_hardening.py: 12 new tests covering all new error/edge paths (None text, empty text, binary file, missing file, bad profile in Engine, missing keys in render helpers, etc.).
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.