swarmauri_tests_pylicense 0.1.2

Overview

swarmauri_tests_pylicense is a pytest plugin that scans a package's full dependency tree and ensures each dependency declares a license. The plugin resolves dependencies recursively, checking every transitive requirement. It inspects both the License metadata field and any Classifier entries that declare a license.

By default, the plugin runs in parameterized mode which creates one test per dependency. An aggregate mode is also available that reports all missing licenses in a single test.

Installation

pip install swarmauri_tests_pylicense

pytest automatically discovers the plugin once it is installed.

Usage

Parameterized (default)

Run pytest with the package name to scan its dependency licenses:

pytest --pylicense-package=<your-package>

Each generated test encodes the full dependency path, the resolved version, and the detected license of the terminal package. For example:

swarmauri_tests_pylicense:license::pkg::depA::depB==1.2.3 [Apache-2.0]

Aggregate

Use the --pylicense-mode=aggregate flag to consolidate checks into one test:

pytest --pylicense-package=<your-package> --pylicense-mode=aggregate

Allow and Disallow Lists

To restrict acceptable licenses, provide a comma-separated allow list or disallow list. These can be passed via command-line options or environment variables.

Command-line:

pytest --pylicense-package=<your-package> --pylicense-allow-list=MIT,Apache-2.0
pytest --pylicense-package=<your-package> --pylicense-disallow-list=GPL

Environment variables:

export PYLICENSE_ALLOW_LIST="MIT,Apache-2.0"
export PYLICENSE_DISALLOW_LIST="GPL"
pytest --pylicense-package=<your-package>

If both are provided, any license not in the allow list or explicitly present in the disallow list will cause a test failure. By default, all licenses are allowed and none are disallowed.

Accepting Specific Dependencies

Some transitive dependencies may ship with unusual or proprietary licenses that are acceptable for your project. Use --pylicense-accept-deps (or the PYLICENSE_ACCEPT_DEPS environment variable) with a comma-separated list to explicitly bypass those packages. For example:

pytest --pylicense-package=<your-package> --pylicense-accept-deps=cffi

This tells the plugin to treat cffi as pre-approved. Any license issues for cffi—including unknown or non-standard licenses—are ignored while other dependencies continue to be validated normally.

License

Licensed under the Apache 2.0 License.