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 3 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 3 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 b75c992 to 22ae204 Compare June 12, 2026 21:59
cognis-digital and others added 4 commits June 13, 2026 03:01
…-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.).
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