cyclonedx.spdx
==============

.. py:module:: cyclonedx.spdx


Functions
---------

.. autoapisummary::

   cyclonedx.spdx.is_supported_id
   cyclonedx.spdx.fixup_id
   cyclonedx.spdx.is_expression


Module Contents
---------------

.. py:function:: is_supported_id(value: str) -> bool

   Validate SPDX-ID according to current spec.


.. py:function:: fixup_id(value: str) -> Optional[str]

   Fixup SPDX-ID.

   :returns: repaired value string, or `None` if fixup was unable to help.


.. py:function:: is_expression(value: str) -> bool

   Validate SPDX license expression.

   .. note::
       Utilizes `license-expression library`_ to
       validate SPDX compound expression according to `SPDX license expression spec`_.

   .. _SPDX license expression spec: https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/
   .. _license-expression library: https://github.com/nexB/license-expression


