sw360 / clipython

Support component license information (CLI) files in Python

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

clipython's Issues

Do not add empty acknowlegments, files and filehashes

At them moment we add acknowlegments, files and filehashes with empty CDATA.
Some tools still interpret this as existing data.

=> Add tags only if there is a real contents