cyclonedx.factory.license
=========================

.. py:module:: cyclonedx.factory.license

.. autoapi-nested-parse::

   .. deprecated:: next



Classes
-------

.. autoapisummary::

   cyclonedx.factory.license.LicenseFactory


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

.. py:class:: LicenseFactory

   Bases: :py:obj:`cyclonedx.contrib.license.factories.LicenseFactory`


   Deprecated — Alias of :class:`cyclonedx.contrib.license.factories.LicenseFactory`.

   .. deprecated:: next
       This re-export location is deprecated.
       Use ``from cyclonedx.contrib.license.factories import LicenseFactory`` instead.
       The exported symbol itself is NOT deprecated — only this import path.


   .. py:method:: make_from_string(value: str, *, license_text: Optional[cyclonedx.model.AttachedText] = None, license_url: Optional[cyclonedx.model.XsUri] = None, license_acknowledgement: Optional[cyclonedx.model.license.LicenseAcknowledgement] = None) -> cyclonedx.model.license.License

      Make a :class:`cyclonedx.model.license.License` from a string.



   .. py:method:: make_with_expression(expression: str, *, acknowledgement: Optional[cyclonedx.model.license.LicenseAcknowledgement] = None) -> cyclonedx.model.license.LicenseExpression

      Make a :class:`cyclonedx.model.license.LicenseExpression` with a compound expression.

      Utilizes :func:`cyclonedx.spdx.is_expression`.

      :raises InvalidLicenseExpressionException: if param `value` is not known/supported license expression



   .. py:method:: make_with_id(spdx_id: str, *, text: Optional[cyclonedx.model.AttachedText] = None, url: Optional[cyclonedx.model.XsUri] = None, acknowledgement: Optional[cyclonedx.model.license.LicenseAcknowledgement] = None) -> cyclonedx.model.license.DisjunctiveLicense

      Make a :class:`cyclonedx.model.license.DisjunctiveLicense` from an SPDX-ID.

      :raises InvalidSpdxLicenseException: if param `spdx_id` was not known/supported SPDX-ID



   .. py:method:: make_with_name(name: str, *, text: Optional[cyclonedx.model.AttachedText] = None, url: Optional[cyclonedx.model.XsUri] = None, acknowledgement: Optional[cyclonedx.model.license.LicenseAcknowledgement] = None) -> cyclonedx.model.license.DisjunctiveLicense

      Make a :class:`cyclonedx.model.license.DisjunctiveLicense` with a name.