Support component license information (CLI) files
Project description
CLI Support for Python
Python library to read and write Component License Information (CLI) files. They can be created by FOSSology and stored in SW360.
For more information about the CLI file format, please have a look at ComponentLicenseInformation.md.
Usage
Installation
This project is available as Python package on PyPi.org.
Install cli_support and required dependencies:
pip install cli_support
Required Packages
- none
Using the API
-
Start using the API:
import cli_support clifile = cli_support.CLI.CliFile() clifile.read_from_file("cli_filename")
Contribute
- All contributions in form of bug reports, feature requests or merge requests are welcome!
- Please use proper docstrings to document functions and classes.
- Extend the testsuite poetry run pytest with the new functions/classes
Build
Building Python package
For building the library, you need Poetry. Build is then simply triggered using
poetry build
This creates the source and wheel files in dist/
subdirectory -- which can then
be uploaded or installed locally using pip
.
Test
Start the complete test suite or a specific test case (and generate coverage report):
poetry run pytest
or
poetry run coverage run -m pytest
poetry run coverage report -m --omit "*/site-packages/*.py"
poetry run coverage html --omit "*/site-packages/*.py"
Demo
The script show_licenses.py
shows how to use the library to retrieve some information
of a given CLI file.
python ./show_licenses.py ./test/testfiles/CLIXML_MIT_simple.xml
License
Copyright 2019-2024 Siemens
The project is licensed under the MIT license.
SPDX-License-Identifier: MIT
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
File details
Details for the file cli_support-2.0.2.tar.gz
.
File metadata
- Download URL: cli_support-2.0.2.tar.gz
- Upload date:
- Size: 9.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.11.0 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5908aeb1fd1c66de6a0de40e10bb2a5cfb54114d928d9b40c478ec8423ddf499 |
|
MD5 | c8128c3170a1dbac47230e36d27c7863 |
|
BLAKE2b-256 | 8944522b7499014dd63881444e86cb44205802409377cbb0f7009f3f078e4fbc |
File details
Details for the file cli_support-2.0.2-py3-none-any.whl
.
File metadata
- Download URL: cli_support-2.0.2-py3-none-any.whl
- Upload date:
- Size: 16.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.0 CPython/3.11.0 Windows/10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f56759f129e2b204f0e84de2dc1ff0a7e1f9187d5d88f0b4e528e9d3acd7f080 |
|
MD5 | 4fed34869dc6ce837e03f0c1a84794f1 |
|
BLAKE2b-256 | ce54b2a5f4ec90ac7139fa8081b3aa6b5e9fa817f314d08d71ca4ff917e83c1b |