Skip to content

Commit ef83a07

Browse files
committed
feat: prepare "contrib" area
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent 562049c commit ef83a07

File tree

4 files changed

+12
-1
lines changed

4 files changed

+12
-1
lines changed

cyclonedx/contrib/license/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@
1414
#
1515
# SPDX-License-Identifier: Apache-2.0
1616
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
18+
"""License related functionality"""

cyclonedx/contrib/license/exceptions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818

1919
"""
20-
Exceptions relating to specific conditions that occur when factoring a model.
20+
Exceptions relating to specific conditions that occur when factoring a module.
2121
"""
2222

2323
from ...exception import CycloneDxException

cyclonedx/contrib/license/factories.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
# SPDX-License-Identifier: Apache-2.0
1616
# Copyright (c) OWASP Foundation. All Rights Reserved.
1717

18+
"""License related factories"""
19+
1820
__all__ = ['LicenseFactory']
1921

2022
from typing import TYPE_CHECKING, Optional
@@ -88,3 +90,8 @@ def make_with_name(self, name: str, *,
8890
) -> DisjunctiveLicense:
8991
"""Make a :class:`cyclonedx.model.license.DisjunctiveLicense` with a name."""
9092
return DisjunctiveLicense(name=name, text=text, url=url, acknowledgement=acknowledgement)
93+
94+
95+
# Idea for more factories:
96+
# class LicenseAttachmentFactory:
97+
# def male_from_file(self, path: PathLike) -> AttachedText: ...

cyclonedx/contrib/this/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@
1414
#
1515
# SPDX-License-Identifier: Apache-2.0
1616
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
18+
"""Representation of this very python library."""

0 commit comments

Comments
 (0)