feat: prepare "contrib" area

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

cyclonedx/builder/this.py

@@ -27,7 +27,7 @@
 else:
     from typing_extensions import deprecated
 
-from ..contrib.this import this_component as _this_component, this_tool as _this_tool
+from ..contrib.this.builders import this_component as _this_component, this_tool as _this_tool
 
 # region deprecated re-export
 
@@ -38,23 +38,23 @@
 
 @deprecated('Deprecated re-export location - see docstring of "this_component" for details.')
 def this_component() -> 'Component':
-    """Deprecated — alias of :func:`~cyclonedx.contrib.this.this_component`.
+    """Deprecated — Alias of :func:`cyclonedx.contrib.this.builders.this_component`.
 
     .. deprecated:: next
         This re-export location is deprecated.
-        Use ``from cyclonedx.contrib.this import this_component`` instead.
+        Use ``from cyclonedx.contrib.this.builders import this_component`` instead.
         The exported symbol itself is NOT deprecated — only this import path.
     """
     return _this_component()
 
 
 @deprecated('Deprecated re-export location - see docstring of "this_tool" for details.')
 def this_tool() -> 'Tool':
-    """Deprecated — alias of :func:`~cyclonedx.contrib.this.this_tool`.
+    """Deprecated — Alias of :func:`cyclonedx.contrib.this.builders.this_tool`.
 
     .. deprecated:: next
         This re-export location is deprecated.
-        Use ``from cyclonedx.contrib.this import this_tool`` instead.
+        Use ``from cyclonedx.contrib.this.builders import this_tool`` instead.
         The exported symbol itself is NOT deprecated — only this import path.
     """
     return _this_tool()

cyclonedx/contrib/license/__init__.py

@@ -0,0 +1,16 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.

cyclonedx/contrib/license.py renamed to cyclonedx/contrib/license/factories.py

@@ -19,13 +19,13 @@
 
 from typing import TYPE_CHECKING, Optional
 
-from ..exception.factory import InvalidLicenseExpressionException, InvalidSpdxLicenseException
-from ..model.license import DisjunctiveLicense, LicenseExpression
-from ..spdx import fixup_id as spdx_fixup, is_expression as is_spdx_expression
+from ...exception.factory import InvalidLicenseExpressionException, InvalidSpdxLicenseException
+from ...model.license import DisjunctiveLicense, LicenseExpression
+from ...spdx import fixup_id as spdx_fixup, is_expression as is_spdx_expression
 
 if TYPE_CHECKING:  # pragma: no cover
-    from ..model import AttachedText, XsUri
-    from ..model.license import License, LicenseAcknowledgement
+    from ...model import AttachedText, XsUri
+    from ...model.license import License, LicenseAcknowledgement
 
 
 class LicenseFactory:

cyclonedx/contrib/this/__init__.py

@@ -0,0 +1,16 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.

cyclonedx/contrib/this.py renamed to cyclonedx/contrib/this/builders.py

@@ -19,11 +19,11 @@
 
 __all__ = ['this_component', 'this_tool', ]
 
-from .. import __version__ as __ThisVersion  # noqa: N812
-from ..model import ExternalReference, ExternalReferenceType, XsUri
-from ..model.component import Component, ComponentType
-from ..model.license import DisjunctiveLicense, LicenseAcknowledgement
-from ..model.tool import Tool
+from ... import __version__ as __ThisVersion  # noqa: N812
+from ...model import ExternalReference, ExternalReferenceType, XsUri
+from ...model.component import Component, ComponentType
+from ...model.license import DisjunctiveLicense, LicenseAcknowledgement
+from ...model.tool import Tool
 
 # !!! keep this file in sync with `pyproject.toml`
 

cyclonedx/factory/license.py

@@ -24,18 +24,18 @@
 else:
     from typing_extensions import deprecated
 
-from ..contrib.license import LicenseFactory as _LicenseFactory
+from ..contrib.license.factories import LicenseFactory as _LicenseFactory
 
 # region deprecated re-export
 
 
 @deprecated('Deprecated re-export location - see docstring of "LicenseFactory" for details.')
 class LicenseFactory(_LicenseFactory):
-    """Deprecated — Alias of :class:`cyclonedx.contrib.license.LicenseFactory`.
+    """Deprecated — Alias of :class:`cyclonedx.contrib.license.factories.LicenseFactory`.
 
     .. deprecated:: next
         This re-export location is deprecated.
-        Use ``from cyclonedx.contrib.license import LicenseFactory`` instead.
+        Use ``from cyclonedx.contrib.license.factories import LicenseFactory`` instead.
         The exported symbol itself is NOT deprecated - only this import path.
     """