LicenseCheck - GitLite

KO | EN

gitlite — search

#python #llm #go #android #machine-learning #rust #nodejs #java #windows #awesome-list #security #mcp #openai #open-source

LicenseCheck

(★ 114)

Output the licenses used by dependencies and check if these are compatible with the project license

File Explorer

Download Latest Version (.zip)

- - mirror-to-codeberg.yaml
  - release.yaml
  - test-lint.yaml
- - README.md
- - examples.md
  - README.md
- - __init__.py
  - cli.py
  - fmt.py
  - html.template
- - __init__.py
  - matrix.csv
- - __init__.py
  - config.py
  - constants.py
  - license.py
  - packageinfo.py
- - osi_approved.txt
  - other.txt
- __init__.py
- __main__.py
- checker.py
- packageinforesolver.py
- session.py
- - name.png
  - proj-icon.png
- - licenseCheckLicenses.txt
  - licenses.txt
  - pypiClassifiers.txt
  - rawLicenses.txt
- - __init__.py
  - test_cli_main.py
  - test_formatter.py
- - __init__.py
  - test_config.py
- __init__.py
- conftest.py
- test_checker.py
- test_license_matrix.py
- test_packageinfo.py
.gitignore
.pre-commit-config.yaml
.pre-commit-hooks.yaml
CHANGELOG.md
LICENSE.md
pyproject.toml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/FHPythonUtils/LicenseCheck

Downloads the entire project code from GitHub to your computer.

cd LicenseCheck

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install licensecheck

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install licensecheck

Installs the package published on PyPI directly — no need to clone the source.

uv run python3 -m basedpyright -p .

Runs the Python script (or module).

uv run python3 -m pytest

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitHub top language](https://img.shields.io/github/languages/top/FHPythonUtils/LicenseCheck.svg?style=for-the-badge&cacheSeconds=28800)](https://raw.githubusercontent.com/FHPythonUtils/)
[![Issues](https://img.shields.io/github/issues/FHPythonUtils/LicenseCheck.svg?style=for-the-badge&cacheSeconds=28800)](https://raw.githubusercontent.com/FHPythonUtils/issues)
[![License](https://img.shields.io/github/license/FHPythonUtils/LicenseCheck.svg?style=for-the-badge&cacheSeconds=28800)](https://raw.githubusercontent.com/FHPythonUtils/LicenseCheck/master/LICENSE.md)
[![Commit activity](https://img.shields.io/github/commit-activity/m/FHPythonUtils/LicenseCheck.svg?style=for-the-badge&cacheSeconds=28800)](https://raw.githubusercontent.com/FHPythonUtils/commits/master)
[![Last commit](https://img.shields.io/github/last-commit/FHPythonUtils/LicenseCheck.svg?style=for-the-badge&cacheSeconds=28800)](https://raw.githubusercontent.com/FHPythonUtils/commits/master)
[![PyPI Downloads](https://img.shields.io/pypi/dm/licensecheck.svg?style=for-the-badge&cacheSeconds=28800)](https://pypistats.org/packages/licensecheck)
[![PyPI Total Downloads](https://img.shields.io/pepy/dt/licensecheck?style=for-the-badge&label=Total%20Downloads&cacheSeconds=28800)](https://pepy.tech/project/licensecheck)
[![PyPI Version](https://img.shields.io/pypi/v/licensecheck.svg?style=for-the-badge&cacheSeconds=28800)](https://pypi.org/project/licensecheck)

# LicenseCheck

<img src="readme-assets/icons/name.png" alt="Project Icon" width="750">

NOTICE: I am not a lawyer (IANAL)

**Any output provided by this software is for general informational purposes only and
should not be construed as legal advice. I am not a lawyer and there is no guarantee that the
information provided here is complete or correct. Any reliance on the information provided by this
software is at your own risk.**

See also: <https://en.wikipedia.org/wiki/IANAL>, [project license (MIT)](/LICENSE.md)

Output the licences used by dependencies and check if these are compatible with
the project license

## Table of Contents

- [Examples from the command-line](#examples-from-the-command-line)
  - [Using pyproject.toml (default if not piping input)](#using-pyprojecttoml-default-if-not-piping-input)
  - [Use csv format](#use-csv-format)
  - [Groups](#groups)
- [Help](#help)
- [Configuration Example](#configuration-example)
  - [Example 1: pyproject.toml](#example-1-pyprojecttoml)
  - [Example 2: licensecheck.json](#example-2-licensecheckjson)
- [Documentation](#documentation)
- [Install With PIP](#install-with-pip)
- [Language information](#language-information)
- [Working with the repo](#working-with-the-repo)
- [Community Files](#community-files)
  - [Licence](#licence)
  - [Changelog](#changelog)
  - [Code of Conduct](#code-of-conduct)
  - [Contributing](#contributing)
  - [Security](#security)
  - [Support](#support)

## Examples from the command-line

See below for the output if you run `licensecheck` in this directory. More examples are available
[here](documentation/user/examples.md)

### Using pyproject.toml (default if not piping input)

```txt
>> licensecheck

Info
┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ Item            ┃ Value        ┃
┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩
│ program         │ licensecheck │
│ version         │ 2025         │
│ license         │ MIT LICENSE  │
│ project_license │ MIT LICENSE  │
└─────────────────┴──────────────┘

List Of Packages
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Compatible ┃ Package             ┃ License(s)                            ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ✔          │ appdirs             │ MIT LICENSE                           │
│ ✔          │ attrs               │ MIT LICENSE                           │
│ ✔          │ boolean-py          │ BSD-2-CLAUSE                          │
│ ✔          │ cattrs              │ MIT LICENSE                           │
│ ✔          │ certifi             │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_  │
│ ✔          │ charset-normalizer  │ MIT LICENSE                           │
│ ✔          │ colorama            │ BSD LICENSE                           │
│ ✔          │ fhconfparser        │ MIT LICENSE                           │
│ ✔          │ idna                │ BSD LICENSE                           │
│ ✔          │ license-expression  │ APACHE-2.0                            │
│ ✔          │ loguru              │ MIT LICENSE                           │
│ ✔          │ markdown            │ BSD LICENSE                           │
│ ✔          │ markdown-it-py      │ MIT LICENSE                           │
│ ✔          │ mdurl               │ MIT LICENSE                           │
│ ✔          │ packaging           │ APACHE SOFTWARE LICENSE;; BSD LICENSE │
│ ✔          │ platformdirs        │ MIT LICENSE                           │
│ ✔          │ pygments            │ BSD LICENSE                           │
│ ✔          │ requests            │ APACHE SOFTWARE LICENSE               │
│ ✔          │ requests-cache      │ BSD LICENSE                           │
│ ✔          │ requirements-parser │ APACHE SOFTWARE LICENSE               │
│ ✔          │ rich                │ MIT LICENSE                           │
│ ✔          │ setuptools          │ MIT LICENSE                           │
│ ✔          │ six                 │ MIT LICENSE                           │
│ ✔          │ tomli               │ MIT LICENSE                           │
│ ✔          │ types-setuptools    │ APACHE SOFTWARE LICENSE               │
│ ✔          │ url-normalize       │ MIT LICENSE                           │
│ ✔          │ urllib3             │ MIT LICENSE                           │
│ ✔          │ uv                  │ APACHE SOFTWARE LICENSE;; MIT LICENSE │
│ ✔          │ win32-setctime      │ MIT LICENSE                           │
└────────────┴─────────────────────┴───────────────────────────────────────┘

```

### Use csv format

```csv
>>> licensecheck  --only-licenses mit apache --show-only-failing -f csv
name,version,size,homePage,author,license,licenseCompat,errorCode,namever
Markdown,3.7,361400,UNKNOWN,"Manfred Stienstra, Yuri Takhteyev",BSD LICENSE,False,0,Markdown-3.7
Pygments,2.19.1,4508396,UNKNOWN,UNKNOWN,BSD LICENSE,False,0,Pygments-2.19.1
boolean.py,4.0,109354,https://github.com/bastikr/boolean.py,Sebastian Kraemer,BSD-2-CLAUSE,False,0,boolean.py-4.0
certifi,2025.1.31,305559,https://github.com/certifi/python-certifi,Kenneth Reitz,MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_,False,0,certifi-2025.1.31
colorama,0.4.6,76299,UNKNOWN,UNKNOWN,BSD LICENSE,False,0,colorama-0.4.6
idna,3.10,349141,UNKNOWN,UNKNOWN,BSD LICENSE,False,0,idna-3.10
requests-cache,1.2.1,174099,https://github.com/requests-cache/requests-cache,Roman Haritonov,BSD LICENSE,False,0,requests-cache-1.2.1
```

### Groups

```txt
uv run licensecheck  --only-licenses mit apache --show-only-failing -g dev

...

List Of Packages
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Compatible ┃ Package           ┃ License(s)                           ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ✖          │ authlib           │ BSD LICENSE                          │
│ ✖          │ boolean-py        │ BSD-2-CLAUSE                         │
│ ✖          │ certifi           │ MOZILLA PUBLIC LICENSE 2.0 _MPL 2.0_ │
│ ✖          │ click             │ BSD LICENSE                          │
│ ✖          │ colorama          │ BSD LICENSE                          │
│ ✖          │ filelock          │ THE UNLICENSE _UNLICENSE_            │
│ ✖          │ idna              │ BSD LICENSE                          │
│ ✖          │ jinja2            │ BSD LICENSE                          │
│ ✖          │ joblib            │ BSD LICENSE                          │
...
```

## Help

```txt
usage: licensecheck [-h] [--license LICENSE] [--format FORMAT] [--requirements-paths REQUIREMENTS_PATHS [REQUIREMENTS_PATHS ...]]
                    [--groups GROUPS [GROUPS ...]] [--extras EXTRAS [EXTRAS ...]] [--file FILE]
                    [--ignore-packages IGNORE_PACKAGES [IGNORE_PACKAGES ...]] [--fail-packages FAIL_PACKAGES [FAIL_PACKAGES ...]]
                    [--ignore-licenses IGNORE_LICENSES [IGNORE_LICENSES ...]] [--fail-licenses FAIL_LICENSES [FAIL_LICENSES ...]]
                    [--only-licenses ONLY_LICENSES [ONLY_LICENSES ...]]
                    [--skip-dependencies SKIP_DEPENDENCIES [SKIP_DEPENDENCIES ...]]
                    [--hide-output-parameters HIDE_OUTPUT_PARAMETERS [HIDE_OUTPUT_PARAMETERS ...]] [--show-only-failing]
                    [--pypi-api PYPI_API] [--zero]

Output the licenses used by dependencies and check if these are compatible with the project license.

options:
  -h, --help            show this help message and exit
  --license LICENSE, -l LICENSE
                        Specify the project license explicitly, rather than rely on licensecheck interpreting this from pyproject.toml
  --format FORMAT, -f FORMAT
                        Output format. one of: json, markdown, html, csv, ansi, simple. default=simple
  --requirements-paths REQUIREMENTS_PATHS [REQUIREMENTS_PATHS ...], -r REQUIREMENTS_PATHS [REQUIREMENTS_PATHS ...]
                        Filenames to read from (omit for stdin if piping, else pyproject.toml)
  --groups GROUPS [GROUPS ...], -g GROUPS [GROUPS ...]
                        Select groups from supported files
  --extras EXTRAS [EXTRAS ...], -e EXTRAS [EXTRAS ...]
                        Select extras from supported files
  --file FILE, -o FILE  Filename to write output to (omit this for stdout)
  --ignore-packages IGNORE_PACKAGES [IGNORE_PACKAGES ...]
                        List of packages/dependencies to ignore (compat=True), globs are supported
  --fail-packages FAIL_PACKAGES [FAIL_PACKAGES ...]
                        List of packages/dependencies to fail (compat=False), globs are supported
  --ignore-licenses IGNORE_LICENSES [IGNORE_LICENSES ...]
                        List of licenses to ignore (skipped, compat may still be False)
  --fail-licenses FAIL_LICENSES [FAIL_LICENSES ...]
                        List of licenses to fail (compat=False)
  --only-licenses ONLY_LICENSES [ONLY_LICENSES ...]
                        List of allowed licenses (packages/dependencies with any other license will fail)
  --skip-dependencies SKIP_DEPENDENCIES [SKIP_DEPENDENCIES ...]
                        List of packages/dependencies to skip (this sets the 'compatability' to True)
  --hide-output-parameters HIDE_OUTPUT_PARAMETERS [HIDE_OUTPUT_PARAMETERS ...]
                        List of parameters to hide from the produced output
  --show-only-failing   Only output a list of incompatible/ failing packages from this lib
  --pypi-api PYPI_API   Specify a custom pypi api endpoint, for example if using a custom pypi server
  --zero, -0            Return non zero exit code if an incompatible license is found, ideal for CI/CD
```

More information on using `licensecheck` from the command line is available [here](documentation/user/README.md)

You can also import this into your own project and use any of the functions
in the DOCS

## Configuration Example

Configuration files are parsed in the following order: `pyproject.toml`, `setup.cfg`,
 `licensecheck.toml`, `licensecheck.json`, `~/licensecheck.toml`, `~/licensecheck.json`,

- ⚠ All config files are parsed, however configuration defined in previous files takes precedent

### Example 1: pyproject.toml

```toml

[tool.licensecheck]
license = "mit"               # Specify the project license explicitly
format = "simple"             # Output format (e.g., "json", "csv", etc.)
requirements_paths = []       # List of filenames to read from
groups = []                   # List of selected groups
extras = []                   # List of selected extras
file = ""                     # Output file (leave empty for stdout)
ignore_packages = []          # Packages/dependencies to ignore
fail_packages = []            # Packages/dependencies that cause failure
ignore_licenses = []          # Licenses to ignore
fail_licenses = []            # Licenses that cause failure
only_licenses = []            # Allowed licenses (all others will fail)
skip_dependencies = []        # Dependencies to skip (compatibility = True)
hide_output_parameters = []   # Parameters to hide from output
show_only_failing = false     # Show only incompatible/failing packages
pypi_api = "https://pypi.org" # Custom PyPI API endpoint
zero = false                  # Return non-zero exit code for incompatible licenses (for CI/CD)

```

### Example 2: licensecheck.json

```json
{
  "tool": {
    "licensecheck": {
      "extras": [],
      "fail_licenses": [],
      "fail_packages": [],
      "file": "",
      "format": "simple",
      "groups": [],
      "hide_output_parameters": [],
      "ignore_licenses": [],
      "ignore_packages": [],
      "license": "mit",
      "only_licenses": [],
      "pypi_api": "https://pypi.org",
      "requirements_paths": [],
      "show_only_failing": false,
      "skip_dependencies": [],
      "zero": false
    }
  }
}
```

## Documentation

A high-level overview of how the documentation is organized organized will help you know
where to look for certain things:

- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the
  machinery. This documentation describes how to use the classes and functions at a lower level
  and assume that you have a good high-level understanding of the software.

## Install With PIP

```python
pip install licensecheck
```

Head to <https://pypi.org/project/licensecheck/> for more info

## Language information

Using python 3.12, to 3.14

## Working with the repo

Clone, the repo with

```bash
git clone https://github.com/FHPythonUtils/DepGather
```

Format

```sh
uv run ruff format
```

Linting

```sh
uv run ruff check
uv run python3 -m basedpyright -p .
```

Testing

```sh
uv run python3 -m pytest
```

Alternatively use `tox` to run tests over a range of python versions

```sh
tox
```

## Community Files

### Licence

MIT License
Copyright (c) FredHappyface
(See the [LICENSE](/LICENSE.md) for more information.)

### Changelog

See the [Changelog](/CHANGELOG.md) for more information.

### Code of Conduct

Online communities include people from many backgrounds. The *Project*
contributors are committed to providing a friendly, safe and welcoming
environment for all. Please see the
[Code of Conduct](https://github.com/FHPythonUtils/.github/blob/master/CODE_OF_CONDUCT.md)
 for more information.

### Contributing

Contributions are welcome, please see the
[Contributing Guidelines](https://github.com/FHPythonUtils/.github/blob/master/CONTRIBUTING.md)
for more information.

### Security

Thank you for improving the security of the project, please see the
[Security Policy](https://github.com/FHPythonUtils/.github/blob/master/SECURITY.md)
for more information.

### Support

Thank you for using this project, I hope it is of use to you. Please be aware that
those involved with the project often do so for fun along with other commitments
(such as work, family, etc). Please see the
[Support Policy](https://github.com/FHPythonUtils/.github/blob/master/SUPPORT.md)
for more information.