Skip to content

Public-release readiness: canonical LICENSE, #110 fix, licence hygiene - #111

Merged
Nerds489 merged 1 commit into
mainfrom
chore/public-release-readiness
Oct 1, 2026
Merged

Nerds489 merged 1 commit into
mainfrom
chore/public-release-readiness

Conversation

@Nerds489

@Nerds489 Nerds489 commented Oct 1, 2026

Copy link
Copy Markdown
Owner

Prepares NETREAPER to be flipped public. Clears the licence gate and fixes the one open issue.

Why

A pre-publication pass measured the repo against the licence gate and found one hard blocker plus doc/hygiene drift. This resolves everything mechanical; two items are deliberately left for the operator (below).

Licence gate: FAIL -> PASS (0 fail, 0 warn)

  • LICENSE restored to the verbatim canonical GPL-3.0. The previous file was a byte-variant (same terms, different line-wrapping and (C) vs ©) that a strict canonical-text check read as a modified GPL (match 0.998). Verified: GitHub still detects GPL-3.0 on this branch, and the gate now reports canonical-text PASS (match 1.0).
  • NOTICE added so the copyright holder's attribution travels with every copy.
  • TRADEMARKS.md added: the GPL grant covers the code, not the name.
  • REUSE.toml states the single licence for the prose under docs/.
  • pyproject.toml license-files + a release.yml guard: every sdist and wheel now carries LICENSE and NOTICE (verified: both land in .dist-info/licenses/).

Fixes #110

The README wifi wep example used concrete arguments, so test_readme_commands_exist executed it, reached the live WEP capture path and hung on a real subprocess wherever aircrack-ng is installed (CI stayed green only by the tool's absence). The example now uses placeholders, so the test checks the command path and --injection via --help instead of running an attack.

Docs / hygiene

  • SECURITY.md supported-versions 10.x -> 12.x.
  • Native-adapter count corrected to 16 in the README (16 single-binary adapters + the read-only CAN adapter; was stated as 14).
  • ROADMAP_VISUAL.md marked as a historical planning document (it was anchored at v8.x).
  • CONTRIBUTING.md gains a Developer Certificate of Origin.
  • VERSION 12.2.0 -> 12.2.1; CHANGELOG entry.

Verification

  • Licence gate: license-check.py --gate -> PASS (0 fail, 0 warn, 1 informational note).
  • Full test suite: 1061 passed, 2 skipped, 0 failed (the 30 Sep wep failure is resolved).
  • Build: sdist + wheel build clean and both carry LICENSE + NOTICE.
  • No Python source changed, so lint / type-check / bats are unaffected.

Left for the operator (not done here, by design)

  1. Commit-email privacy. A personal email is the author on 38 of the 78 commits. Going public archives it permanently. Scrubbing it means rewriting history and force-pushing main (against the standing git rules) and needs that contributor's consent, so it is a deliberate decision, not an automatic fix.
  2. The public flip itself. Outward and hard to reverse; the gate passing is a precondition, your word is the other.

…ce hygiene

Clears the licence gate (was FAIL on canonical-text; now PASS, 0 warn) and
fixes the one open issue, ahead of flipping the repo public.

- LICENSE restored to the verbatim canonical GPL-3.0 text. The previous file was
  a byte-for-byte variant (same terms, different wrapping) that a strict
  canonical-text check read as a modified licence. No change to the licence.
- NOTICE added so the copyright holder's attribution travels with every copy;
  TRADEMARKS.md added (the GPL grant covers the code, not the name); REUSE.toml
  states the single licence for the prose under docs/.
- pyproject license-files = [LICENSE, NOTICE] and a release.yml guard, so every
  built sdist and wheel carries the licence (verified: both land in
  .dist-info/licenses/).
- README wifi wep example now uses placeholders, so test_readme_commands_exist
  checks the command path and --injection via --help instead of executing the
  live WEP capture and hanging where aircrack-ng is installed (#110).
- CONTRIBUTING gains a Developer Certificate of Origin; SECURITY supported
  versions 10.x -> 12.x; native-adapter count corrected to 16 in the README;
  ROADMAP_VISUAL marked as a historical planning document.
- VERSION 12.2.0 -> 12.2.1; CHANGELOG entry.

Closes #110.

Signed-off-by: Nerds489 <194747308+Nerds489@users.noreply.github.com>
@Nerds489
Nerds489 merged commit 5d89d3c into main Oct 1, 2026
2 checks passed
@Nerds489
Nerds489 deleted the chore/public-release-readiness branch October 1, 2026 09:19
Nerds489 added a commit that referenced this pull request Oct 1, 2026
Public-release readiness: canonical LICENSE, #110 fix, licence hygiene
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.

test: wifi wep README example uses concrete args and hangs the README-command test where aircrack-ng is installed (CI green only by tool absence)

1 participant