Skip to content

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

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

Repo hardening: fix install instructions, dead imports, hygiene#1
cognis-digital wants to merge 4 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 4 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 4 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 d8d491e to d44f69f Compare June 12, 2026 21:49
Cognis Digital added 3 commits June 13, 2026 03:56
tests/test_smoke.py was importing a v1-era API (analyze_dependencies,
analyze_manifest, score_dependency, _edit_distance, _is_below,
_typosquat_match, Dependency with pin-string arg, CLI 'scan' command)
that no longer exists in the current source. Rewrote the test module to
match the real current API (audit_dependency, audit_file, levenshtein,
version_compare, typosquat_match, CLI 'audit' command) while preserving
assertions on the same real behaviors. All 46 tests now pass.

Also added layman.md with a plain-language description, inserted the
"What is this?" and "Install" sections into README.md via enrich.py,
and updated install.sh + added install.ps1 cross-platform install scripts.
- cli.py: catch ValueError (malformed manifest) and broad Exception in
  audit command so all error paths print to stderr and return exit 2,
  never a raw traceback; guard stdin read against UnicodeDecodeError
- core.py: _parse_package_json raises ValueError with clear message on
  invalid JSON or non-object top level, and skips empty-string names;
  returns empty list for empty input rather than crashing
- core.py: _parse_pipfile guards against empty names after stripping and
  wraps regex logic in try/except for type-safety
- core.py: parse_manifest accepts None text (treated as empty string)
- core.py: Dependency.max_severity guards against unknown severity
  strings via try/except on list.index() calls
- tests/test_hardening.py: 20 new tests covering empty manifests,
  malformed JSON, unknown severity, empty-stdin audit, missing files,
  and CLI error-path exit codes
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