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 5f9a078 to 5d4e01d Compare June 12, 2026 21:57
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: 14 tests passed, 0 parse errors, CLI C:\Python314\python.exe: No module named https
- embedded results in README ## Verification and AUDIT.md
- layman.md: 4-sentence plain-English description of what optout does
- README.md: insert "What is this?" section and comprehensive Install section
  (managed with cognis:layman/install sentinels; idempotent)
- install.sh: comprehensive POSIX installer (pipx→uv→pip→source)
- install.ps1: comprehensive Windows PowerShell installer
- load_profile now raises FileNotFoundError (with message) for missing
  files, ValueError with clear text for malformed JSON and non-object
  payloads, and OSError for unreadable files; previously any of these
  produced a raw traceback.
- build_requests raises ValueError on an empty only=[] list (was
  silently treating it as "no filter"); get_broker None results are
  now filtered out defensively before iteration.
- render_letter guards against a None broker argument.
- render_all skips broker-slug lookup failures defensively.
- summarize maps unknown status values to "pending" rather than
  accumulating them outside the known-status keys.
- cli.py main() catches OSError in addition to FileNotFoundError so
  permission-denied and similar I/O errors surface as "error: ..."
  messages instead of tracebacks.
- webhook.py: fix E401 (split multi-import), validate --url scheme,
  and reject empty stdin before making the network request.
- Add tests/test_hardening.py with 16 new tests covering all new
  error paths and edge cases.
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