cyclonedx.schema
================

.. py:module:: cyclonedx.schema


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/cyclonedx/schema/schema/index


Classes
-------

.. autoapisummary::

   cyclonedx.schema.OutputFormat
   cyclonedx.schema.SchemaVersion


Package Contents
----------------

.. py:class:: OutputFormat(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Output formats.

   Cases are hashable.

   Do not rely on the actual/literal values, just use enum cases, like so:
       my_of = OutputFormat.XML


   .. py:attribute:: JSON


   .. py:attribute:: XML


.. py:class:: SchemaVersion(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Schema version.

   Cases are hashable.
   Cases are comparable(!=,>=,>,==,<,<=)

   Do not rely on the actual/literal values, just use enum cases, like so:
       my_sv = SchemaVersion.V1_3


   .. py:attribute:: V1_7
      :value: (1, 7)



   .. py:attribute:: V1_6
      :value: (1, 6)



   .. py:attribute:: V1_5
      :value: (1, 5)



   .. py:attribute:: V1_4
      :value: (1, 4)



   .. py:attribute:: V1_3
      :value: (1, 3)



   .. py:attribute:: V1_2
      :value: (1, 2)



   .. py:attribute:: V1_1
      :value: (1, 1)



   .. py:attribute:: V1_0
      :value: (1, 0)



   .. py:method:: from_version(version: str) -> _SV
      :classmethod:


      Return instance based of a version string - e.g. `1.4`



   .. py:method:: to_version() -> str

      Return as a version string - e.g. `1.4`