Scan project dependency manifests for license compliance risk (GPL/AGPL/LGPL exposure) before it becomes a legal problem.
Project description
license-radar
Scan a project's dependency manifests (requirements.txt, pyproject.toml,
setup.py, setup.cfg, Pipfile, package.json) for license compliance risk before a
GPL/AGPL dependency turns into a legal problem for a closed-source product.
Why
Pulling in a GPL- or AGPL-licensed dependency can obligate a company to open its own source, or expose it to a lawsuit — and it usually happens by accident, several dependency layers deep. Existing SCA/security scanners focus on vulnerabilities; license risk is often an afterthought bolted onto an expensive enterprise product. This is a small, focused tool that does just the license check, fast, in CI.
Install
pip install license-radar
Usage
license-radar scan . # scan a directory tree (recurses into subprojects)
license-radar scan requirements.txt # scan a single manifest
license-radar scan . --online # also query PyPI/npm for packages not in the local DB
license-radar scan . --json # machine-readable output for CI
license-radar scan . --policy policy.json
Directory scans recurse into subdirectories, so monorepos with manifests in
nested subprojects (e.g. services/api/requirements.txt,
frontend/package.json) are covered in a single run. Vendored and environment
directories (node_modules, .venv, vendor, dist, VCS/cache dirs, …) are
skipped so the scan reflects what the project itself declares, not the
manifests bundled inside its dependencies.
Within each manifest, every section that declares the project's own
dependencies is scanned — not just the primary one. For pyproject.toml that
includes PEP 621 [project.optional-dependencies] extras, the PEP 735
[dependency-groups] table (pip --group), Poetry
[tool.poetry.group.*.dependencies] groups, the legacy Poetry (< 1.2)
[tool.poetry.dev-dependencies] table, PDM
[tool.pdm.dev-dependencies], and Hatch environment dependencies
([tool.hatch.envs.*] dependencies / extra-dependencies); for legacy
setup.py it statically reads (never executing the file) the install_requires,
extras_require, and tests_require arguments to setup(), resolving the common
REQUIRES = [...] variable pattern and skipping dynamically-computed entries; for
legacy setup.cfg it includes
[options] install_requires, tests_require, setup_requires, and
[options.extras_require]; for Pipenv
Pipfile it includes [packages] and [dev-packages]; for package.json
it includes optionalDependencies and peerDependencies. A copyleft
dependency hidden in a test/docs extra or an optional group is exactly the
kind of accidental exposure this tool exists to catch.
Requirements files that pull in other files with pip's -r other.txt /
--requirement other.txt directive are followed (resolved relative to the
including file, with cycle guarding), so a dependency declared only in an
included file — e.g. a thin requirements.txt that does -r prod.txt — is
scanned too. -c/--constraint files only pin versions of already-required
packages, so they are not followed.
VCS and URL requirements are handled by their real package name: a
git+https://…#egg=<name> reference (including an editable -e …#egg=<name>
install) contributes <name>, and a bare archive URL with no #egg= fragment
contributes nothing — the URL scheme is never mistaken for a package. This keeps
a copyleft dependency installed straight from a VCS from slipping through, and
avoids spurious git/https entries in the report.
Backslash line continuations are joined into one logical line before parsing,
the same way pip reads them. A hash-pinned requirement spread over several
\-continued lines contributes just its package name, and an environment
marker split across a continuation (pkg; marker \ / and platform_system ...) no longer leaks its leading word as a phantom unknown dependency.
Exit code is 1 if any dependency violates the policy (useful as a CI gate),
0 otherwise.
The license-radar report command generates a standalone HTML audit report
from the same scan — see Pro below.
pre-commit
This repo is a pre-commit hook source. Add to a
project's .pre-commit-config.yaml:
repos:
- repo: https://github.com/Hiro-012/claude-
rev: <commit SHA of a published license-radar version>
hooks:
- id: license-radar
(This repo doesn't tag releases yet — pin a commit SHA from the history of
pyproject.toml version bumps until versioned tags are published.)
The hook runs on any commit that touches requirements*.txt, pyproject.toml,
setup.py, setup.cfg, Pipfile, or package.json, and blocks the commit if a new
dependency violates policy.
Policy
By default, any strong-copyleft (GPL/AGPL/SSPL) or unknown license is a
violation. Override with a JSON file:
{
"fail_at_or_above": "weak-copyleft",
"treat_unknown_as_violation": false
}
How it classifies
Licenses are normalized to an SPDX id and bucketed into four tiers:
permissive < weak-copyleft < strong-copyleft < unknown. See
license_radar/classify.py for the exact lists.
Limitations
The offline database (license_radar/license_db.py) is a hand-curated table
of ~305 common PyPI/npm packages (each entry verified against the live
registry JSON API), not a registry mirror — use --online for full coverage
against live PyPI/npm metadata (adds a network dependency and is not covered
by the deterministic test suite). Compound SPDX license expressions that
registries declare — A OR B (the licensee may choose, so the least
restrictive operand governs) and A AND B (both apply, so the most
restrictive governs) — are resolved to a single tier by operator semantics
rather than reported as unknown. For example pycurl's
LGPL-2.1-only OR MIT resolves to permissive (MIT is a valid choice) and
pyside6's LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only to weak-copyleft
(LGPL is the least restrictive option); any operand the classifier cannot
resolve leaves the whole expression unknown rather than guessed.
Because the offline table is keyed by package name only, a package whose
license changed across its version history cannot be pinned to a single
correct value. Such packages are deliberately left out of the table and
reported as unknown (flagged for review) rather than guessed — for example
chardet, which is LGPL-2.1-or-later up to 5.2.0 but relicensed to 0BSD in
its 6.x/7.x line. Use --online with a pinned version, or check the specific
version you depend on, when a dependency is reported this way.
To keep the offline table honest as upstream licenses change, every real entry
is reconciled against the live PyPI/npm registries by scripts/audit_db.py,
which compares each package's stored risk tier with the registry's current
declared license and reports any drift. It runs on a schedule and on any change
to the database in CI (.github/workflows/audit-license-db.yml); the chardet
relicensing above is the kind of drift it exists to catch. The classifier
recognizes registries' free-text and compound license strings where they are
tier-unambiguous (Apache License 2.0, 3-Clause BSD License, LGPL-2.1,
CC0-1.0, MIT-CMU, Python Software Foundation License, and AND/OR
expressions). Some trove classifiers name a license family whose exact SPDX
id is unrecoverable (a bare BSD License does not say 2- vs 3-clause) but whose
compliance tier is certain; because the audit compares tiers, those are still
drift-checked rather than punted. Entries the registry leaves genuinely
tier-ambiguous or unlabeled are reported as UNVERIFIABLE and left for human
review rather than guessed. A recent live run reconciled 305 entries as
304 OK / 0 drift / 1 unverifiable.
Detection accuracy
scripts/measure_accuracy.py measures the scan pipeline itself: it generates a
manifest declaring every package in the offline database, runs a real scan
(parse → lookup → classify → policy), and checks that each dependency gets the
verdict its known tier requires. It reports recall (fraction of known-risky
dependencies flagged) and false-positive rate (fraction of non-risky
dependencies wrongly flagged). Latest run over all 305 curated packages:
| Policy | Risky packages | Recall | False-positive rate |
|---|---|---|---|
| default (strong-copyleft + unknown) | 13 | 100.00% | 0.00% |
strict (fail_at_or_above: weak-copyleft) |
23 | 100.00% | 0.00% |
This validates that no known copyleft dependency is silently dropped by
parsing, name normalization, classification, or policy — the failure mode that
would make a compliance gate quietly useless. It takes the database as the
oracle, so it measures the pipeline, not the database's fidelity to live
registries; that separate check is scripts/audit_db.py above. The same
measurement runs in the test suite (tests/test_accuracy.py) as a regression
guard, and the script exits non-zero if recall ever drops below 100% or a
false positive appears.
License
MIT
Pro
The core check is and stays free: license-radar scan — directory/monorepo
scanning, every manifest format, --online lookups, --json, --policy, the
pre-commit hook — runs entirely on your machine, sends no telemetry, and never
asks for a key.
Pro adds one thing: license-radar report, which turns a scan into a
standalone HTML compliance audit report — a per-dependency table with
violations highlighted, risk-tier summary, the applied policy, and an explicit
audit scope listing exactly which manifest files were examined — in a single
self-contained file suitable for archiving or handing to legal/compliance
review. It's a one-time purchase (no subscription, no account):
→ https://buy.stripe.com/cNifZifg06eld9La50dMI01
After purchase you receive a license key. Use it via the flag or an env var:
license-radar report . --license-key <KEY> -o audit.html
# or
export LICENSE_RADAR_KEY=<KEY>
license-radar report . -o audit.html
Without a valid key, report prints the purchase link and exits non-zero; the
free scan command is completely unaffected.
license-radar is built and maintained independently under the HiroCheck
name. Starring the repo, or opening an issue when the database gets a package's
license wrong, helps too and costs nothing.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file license_radar-0.1.26.tar.gz.
File metadata
- Download URL: license_radar-0.1.26.tar.gz
- Upload date:
- Size: 47.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
806a8a8a22af80313a27c7d332a4f441a06fe881ab722e0223c488a389ce239d
|
|
| MD5 |
5029def03624a0840bd5f2199e4471ec
|
|
| BLAKE2b-256 |
4b1c9ab8e49fe771923a3fbc6d62b9d25adda345f23b92076fd58467cfa5040c
|
File details
Details for the file license_radar-0.1.26-py3-none-any.whl.
File metadata
- Download URL: license_radar-0.1.26-py3-none-any.whl
- Upload date:
- Size: 31.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aca51188c64bcd9e0f287cf4c827e12b9f3f8ec8ad7c1047a8d4affdc3da0833
|
|
| MD5 |
6a24d80376163e7379397ec7d52106d4
|
|
| BLAKE2b-256 |
f10f74b88a5974e2af1d07cad75aa351e383e91a25e9b55011e909a55e65e3fc
|