Licomp Toolkit
Licomp toolkit is a license compatiblity tool using miscellaneous available compatibility resources and provides replies from all resources.
Introduction
Licomp can be used to help determine if a license is compatible with an outbound license. These compatibility checks needs context which is often missing. The context above must be provided to licomp-toolkit. In short the context is:
- use case - how you use the licensed component
- provisioning - how you provide the component to your user
- modification - if you have modified the component
Licomp toolkit is using the Licomp api to communicate with the Licomp resources. For a better understanding of Licomp we suggest you read:
Licomp resources
Licomp toolkit uses the following compatibility resources using the Licomp api: licomp-hermione, licomp-osadl, licomp-proprietary, licomp-reclicense, licomp-dwheeler and licomp-gnuguide.
Using Licomp Toolkit
Command line interface (brief intro)
If you want to check if the following is compatible:
- outbound license "MIT"
- inbound license "LGPL-2.0-or-later"
$ licomp-toolkit verify -il MIT -ol LGPL-2.0-or-later | jq .summary.results
{
"nr_valid": "1",
"yes": {
"count": 1,
"percent": 100.0
}
}
In the above example, licomp-toolkit by default chose:
- usecase
library- i.e. the licenses component is used as a library (e.g. linking to it) - provisioning
binary-distribution - modification is not yet implemented
For more detailed guides to licomp-toolkit, please check out:
Python module
If you want to check if the following is compatible:
- outbound license "MIT"
- inbound license "LGPL-2.0-or-later"
>>> from licomp_toolkit.toolkit import LicompToolkit
>>> licomp_toolkit = LicompToolkit()
>>> compatibilities = licomp_toolkit.outbound_inbound_compatibility("MIT", "LGPL-2.0-or-later", "library", "binary-distribution")
>>> print(str(compatibilities['summary']['results']))
{'nr_valid': '1', 'yes': {'count': 1, 'percent': 100.0}}
For a more detailed guide to the licomp-toolkit Python api, please check out: Licomp Toolkit - Python module
Installing Licomp Toolkit
From pypi.org
Licomp Toolkit is available via pypi.org at: https://pypi.org/project/licomp-toolkit/. To install, simply do the following:
$ pip install licomp-toolkit
From github
Installing from github assumes you already have pip installed.
$ git clone https://github.com/hesa/licomp-toolkit
$ pip install -r requirements.txt
$ pip install -r requirements-dev.txt
$ pip install .
1 maintainer
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 licomp_toolkit-0.5.20.tar.gz.
File metadata
- Download URL: licomp_toolkit-0.5.20.tar.gz
- Upload date:
- Size: 37.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98cb2b775c58ba705f5598f69c52deffe46ca8ce3f3ed676e647ca377e4d4eac
|
|
| MD5 |
a30cfabbff36210e4cddd6735e290f53
|
|
| BLAKE2b-256 |
7eb283c85e53f30681013abd9382058a578a688536c99a289b977ad95f1712d4
|
File details
Details for the file licomp_toolkit-0.5.20-py2.py3-none-any.whl.
File metadata
- Download URL: licomp_toolkit-0.5.20-py2.py3-none-any.whl
- Upload date:
- Size: 42.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
598e0d131dd6414d5e04c8400c2dbbc317610068aa17fc11b719e33b7c9d64c0
|
|
| MD5 |
2d4b7cdef51bf2101cc5829fb1d9cebc
|
|
| BLAKE2b-256 |
e97fd1f5c0d194398d0d9d64a7e7e61d54156f1ab391fb2487197c57c18d82ba
|
