spdx · meretp · Jan 10, 2023 · Jan 9, 2023 · Jan 9, 2023
diff --git a/.github/workflows/install_and_test.yml b/.github/workflows/install_and_test.yml
@@ -26,3 +26,5 @@ jobs:
         shell: bash
       - name: Run tests
         run: pytest
+      - name: Run CLI
+        run: pyspdxtools -i ./tests/data/formats/SPDXJSONExample-v2.3.spdx.json
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,7 +31,7 @@ dynamic = ["version"]
 test = ["pytest"]
 
 [project.scripts]
-pyspdxtools = "src.clitools.pyspdxtools:main"
+pyspdxtools = "spdx.clitools.pyspdxtools:main"
 
 [tool.setuptools]
 zip-safe = false  # because of the uses of __file__: https://github.com/spdx/tools-python/issues/257

diff --git a/src/__init__.py → src/spdx/__init__.py b/src/__init__.py → src/spdx/__init__.py
diff --git a/src/clitools/__init__.py → src/spdx/clitools/__init__.py b/src/clitools/__init__.py → src/spdx/clitools/__init__.py
diff --git a/src/clitools/pyspdxtools.py → src/spdx/clitools/pyspdxtools.py b/src/clitools/pyspdxtools.py → src/spdx/clitools/pyspdxtools.py
@@ -15,12 +15,12 @@
 
 import click
 
-from src.model.document import Document
-from src.parser.parse_anything import parse_file
-from src.validation.document_validator import validate_full_spdx_document
-from src.validation.validation_message import ValidationMessage
-from src.writer.tagvalue import tagvalue_writer
-from src.writer.write_anything import write_file
+from spdx.model.document import Document
+from spdx.parser.parse_anything import parse_file
+from spdx.validation.document_validator import validate_full_spdx_document
+from spdx.validation.validation_message import ValidationMessage
+from spdx.writer.tagvalue import tagvalue_writer
+from spdx.writer.write_anything import write_file
 
 
 @click.command()

diff --git a/src/config.py → src/spdx/config.py b/src/config.py → src/spdx/config.py
@@ -13,7 +13,7 @@
 import json
 import os
 
-from src.model.version import Version
+from spdx.model.version import Version
 
 _base_dir = os.path.dirname(__file__)
 _licenses = os.path.join(_base_dir, "licenses.json")

diff --git a/src/datetime_conversions.py → src/spdx/datetime_conversions.py b/src/datetime_conversions.py → src/spdx/datetime_conversions.py
diff --git a/src/document_utils.py → src/spdx/document_utils.py b/src/document_utils.py → src/spdx/document_utils.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from typing import List
 
-from src.model.document import Document
+from spdx.model.document import Document
 
 
 def get_contained_spdx_element_ids(document: Document) -> List[str]:

diff --git a/src/exceptions.json → src/spdx/exceptions.json b/src/exceptions.json → src/spdx/exceptions.json
diff --git a/src/formats.py → src/spdx/formats.py b/src/formats.py → src/spdx/formats.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import Enum, auto
 
-from src.parser.error import SPDXParsingError
+from spdx.parser.error import SPDXParsingError
 
 
 class FileFormat(Enum):

diff --git a/src/jsonschema/__init__.py → src/spdx/jsonschema/__init__.py b/src/jsonschema/__init__.py → src/spdx/jsonschema/__init__.py
diff --git a/src/jsonschema/annotation_converter.py → src/spdx/jsonschema/annotation_converter.py b/src/jsonschema/annotation_converter.py → src/spdx/jsonschema/annotation_converter.py
@@ -10,12 +10,12 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.datetime_conversions import datetime_to_iso_string
-from src.jsonschema.annotation_properties import AnnotationProperty
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.json_property import JsonProperty
-from src.model.annotation import Annotation
-from src.model.document import Document
+from spdx.datetime_conversions import datetime_to_iso_string
+from spdx.jsonschema.annotation_properties import AnnotationProperty
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.model.annotation import Annotation
+from spdx.model.document import Document
 
 
 class AnnotationConverter(TypedConverter[Annotation]):

diff --git a/src/jsonschema/annotation_properties.py → src/spdx/jsonschema/annotation_properties.py b/src/jsonschema/annotation_properties.py → src/spdx/jsonschema/annotation_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class AnnotationProperty(JsonProperty):

diff --git a/src/jsonschema/checksum_converter.py → src/spdx/jsonschema/checksum_converter.py b/src/jsonschema/checksum_converter.py → src/spdx/jsonschema/checksum_converter.py
@@ -10,11 +10,11 @@
 # limitations under the License.
 from typing import Type
 
-from src.jsonschema.checksum_properties import ChecksumProperty
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.json_property import JsonProperty
-from src.model.checksum import Checksum, ChecksumAlgorithm
-from src.model.document import Document
+from spdx.jsonschema.checksum_properties import ChecksumProperty
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.model.checksum import Checksum, ChecksumAlgorithm
+from spdx.model.document import Document
 
 
 class ChecksumConverter(TypedConverter[Checksum]):

diff --git a/src/jsonschema/checksum_properties.py → src/spdx/jsonschema/checksum_properties.py b/src/jsonschema/checksum_properties.py → src/spdx/jsonschema/checksum_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class ChecksumProperty(JsonProperty):

diff --git a/src/jsonschema/converter.py → src/spdx/jsonschema/converter.py b/src/jsonschema/converter.py → src/spdx/jsonschema/converter.py
@@ -11,9 +11,9 @@
 from abc import ABC, abstractmethod
 from typing import Any, Type, Dict, TypeVar, Generic
 
-from src.jsonschema.json_property import JsonProperty
-from src.model.document import Document
-from src.writer.casing_tools import snake_case_to_camel_case
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.model.document import Document
+from spdx.writer.casing_tools import snake_case_to_camel_case
 
 MISSING_IMPLEMENTATION_MESSAGE = "Must be implemented"
 

diff --git a/src/jsonschema/creation_info_converter.py → ...pdx/jsonschema/creation_info_converter.py b/src/jsonschema/creation_info_converter.py → ...pdx/jsonschema/creation_info_converter.py
@@ -10,12 +10,12 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.datetime_conversions import datetime_to_iso_string
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.creation_info_properties import CreationInfoProperty
-from src.jsonschema.json_property import JsonProperty
-from src.jsonschema.optional_utils import apply_if_present
-from src.model.document import CreationInfo, Document
+from spdx.datetime_conversions import datetime_to_iso_string
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.creation_info_properties import CreationInfoProperty
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.optional_utils import apply_if_present
+from spdx.model.document import CreationInfo, Document
 
 
 class CreationInfoConverter(TypedConverter[CreationInfo]):

diff --git a/src/jsonschema/creation_info_properties.py → ...dx/jsonschema/creation_info_properties.py b/src/jsonschema/creation_info_properties.py → ...dx/jsonschema/creation_info_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class CreationInfoProperty(JsonProperty):

diff --git a/src/jsonschema/document_converter.py → src/spdx/jsonschema/document_converter.py b/src/jsonschema/document_converter.py → src/spdx/jsonschema/document_converter.py
@@ -10,21 +10,21 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.document_utils import get_contained_spdx_element_ids
-from src.jsonschema.annotation_converter import AnnotationConverter
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.creation_info_converter import CreationInfoConverter
-from src.jsonschema.document_properties import DocumentProperty
-from src.jsonschema.external_document_ref_converter import ExternalDocumentRefConverter
-from src.jsonschema.extracted_licensing_info_converter import ExtractedLicensingInfoConverter
-from src.jsonschema.file_converter import FileConverter
-from src.jsonschema.json_property import JsonProperty
-from src.jsonschema.package_converter import PackageConverter
-from src.jsonschema.relationship_converter import RelationshipConverter
-from src.jsonschema.snippet_converter import SnippetConverter
-from src.model.document import Document
-from src.model.relationship import RelationshipType
-from src.model.relationship_filters import filter_by_type_and_origin, filter_by_type_and_target, \
+from spdx.document_utils import get_contained_spdx_element_ids
+from spdx.jsonschema.annotation_converter import AnnotationConverter
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.creation_info_converter import CreationInfoConverter
+from spdx.jsonschema.document_properties import DocumentProperty
+from spdx.jsonschema.external_document_ref_converter import ExternalDocumentRefConverter
+from spdx.jsonschema.extracted_licensing_info_converter import ExtractedLicensingInfoConverter
+from spdx.jsonschema.file_converter import FileConverter
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.package_converter import PackageConverter
+from spdx.jsonschema.relationship_converter import RelationshipConverter
+from spdx.jsonschema.snippet_converter import SnippetConverter
+from spdx.model.document import Document
+from spdx.model.relationship import RelationshipType
+from spdx.model.relationship_filters import filter_by_type_and_origin, filter_by_type_and_target, \
     find_package_contains_file_relationships, \
     find_file_contained_by_package_relationships
 

diff --git a/src/jsonschema/document_properties.py → src/spdx/jsonschema/document_properties.py b/src/jsonschema/document_properties.py → src/spdx/jsonschema/document_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class DocumentProperty(JsonProperty):

diff --git a/...schema/external_document_ref_converter.py → ...schema/external_document_ref_converter.py b/...schema/external_document_ref_converter.py → ...schema/external_document_ref_converter.py
@@ -10,12 +10,12 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.jsonschema.checksum_converter import ChecksumConverter
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.external_document_ref_properties import ExternalDocumentRefProperty
-from src.jsonschema.json_property import JsonProperty
-from src.model.document import Document
-from src.model.external_document_ref import ExternalDocumentRef
+from spdx.jsonschema.checksum_converter import ChecksumConverter
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.external_document_ref_properties import ExternalDocumentRefProperty
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.model.document import Document
+from spdx.model.external_document_ref import ExternalDocumentRef
 
 
 class ExternalDocumentRefConverter(TypedConverter[ExternalDocumentRef]):

diff --git a/...chema/external_document_ref_properties.py → ...chema/external_document_ref_properties.py b/...chema/external_document_ref_properties.py → ...chema/external_document_ref_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class ExternalDocumentRefProperty(JsonProperty):

diff --git a/...nschema/external_package_ref_converter.py → ...nschema/external_package_ref_converter.py b/...nschema/external_package_ref_converter.py → ...nschema/external_package_ref_converter.py
@@ -10,11 +10,11 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.external_package_ref_properties import ExternalPackageRefProperty
-from src.jsonschema.json_property import JsonProperty
-from src.model.document import Document
-from src.model.package import ExternalPackageRef
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.external_package_ref_properties import ExternalPackageRefProperty
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.model.document import Document
+from spdx.model.package import ExternalPackageRef
 
 
 class ExternalPackageRefConverter(TypedConverter[ExternalPackageRef]):

diff --git a/...schema/external_package_ref_properties.py → ...schema/external_package_ref_properties.py b/...schema/external_package_ref_properties.py → ...schema/external_package_ref_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class ExternalPackageRefProperty(JsonProperty):

diff --git a/...ema/extracted_licensing_info_converter.py → ...ema/extracted_licensing_info_converter.py b/...ema/extracted_licensing_info_converter.py → ...ema/extracted_licensing_info_converter.py
@@ -10,12 +10,12 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.extracted_licensing_info_properties import ExtractedLicensingInfoProperty
-from src.jsonschema.json_property import JsonProperty
-from src.jsonschema.optional_utils import apply_if_present
-from src.model.document import Document
-from src.model.extracted_licensing_info import ExtractedLicensingInfo
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.extracted_licensing_info_properties import ExtractedLicensingInfoProperty
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.optional_utils import apply_if_present
+from spdx.model.document import Document
+from spdx.model.extracted_licensing_info import ExtractedLicensingInfo
 
 
 class ExtractedLicensingInfoConverter(TypedConverter[ExtractedLicensingInfo]):

diff --git a/...ma/extracted_licensing_info_properties.py → ...ma/extracted_licensing_info_properties.py b/...ma/extracted_licensing_info_properties.py → ...ma/extracted_licensing_info_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class ExtractedLicensingInfoProperty(JsonProperty):

diff --git a/src/jsonschema/file_converter.py → src/spdx/jsonschema/file_converter.py b/src/jsonschema/file_converter.py → src/spdx/jsonschema/file_converter.py
@@ -10,14 +10,14 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.jsonschema.annotation_converter import AnnotationConverter
-from src.jsonschema.checksum_converter import ChecksumConverter
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.file_properties import FileProperty
-from src.jsonschema.json_property import JsonProperty
-from src.jsonschema.optional_utils import apply_if_present
-from src.model.document import Document
-from src.model.file import File
+from spdx.jsonschema.annotation_converter import AnnotationConverter
+from spdx.jsonschema.checksum_converter import ChecksumConverter
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.file_properties import FileProperty
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.optional_utils import apply_if_present
+from spdx.model.document import Document
+from spdx.model.file import File
 
 
 class FileConverter(TypedConverter[File]):

diff --git a/src/jsonschema/file_properties.py → src/spdx/jsonschema/file_properties.py b/src/jsonschema/file_properties.py → src/spdx/jsonschema/file_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class FileProperty(JsonProperty):

diff --git a/src/jsonschema/json_property.py → src/spdx/jsonschema/json_property.py b/src/jsonschema/json_property.py → src/spdx/jsonschema/json_property.py
diff --git a/src/jsonschema/optional_utils.py → src/spdx/jsonschema/optional_utils.py b/src/jsonschema/optional_utils.py → src/spdx/jsonschema/optional_utils.py
diff --git a/src/jsonschema/package_converter.py → src/spdx/jsonschema/package_converter.py b/src/jsonschema/package_converter.py → src/spdx/jsonschema/package_converter.py
@@ -10,19 +10,19 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.datetime_conversions import datetime_to_iso_string
-from src.jsonschema.annotation_converter import AnnotationConverter
-from src.jsonschema.checksum_converter import ChecksumConverter
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.external_package_ref_converter import ExternalPackageRefConverter
-from src.jsonschema.json_property import JsonProperty
-from src.jsonschema.optional_utils import apply_if_present
-from src.jsonschema.package_properties import PackageProperty
-from src.jsonschema.package_verification_code_converter import PackageVerificationCodeConverter
-from src.model.actor import Actor
-from src.model.document import Document
-from src.model.package import Package
-from src.model.relationship_filters import find_package_contains_file_relationships, \
+from spdx.datetime_conversions import datetime_to_iso_string
+from spdx.jsonschema.annotation_converter import AnnotationConverter
+from spdx.jsonschema.checksum_converter import ChecksumConverter
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.external_package_ref_converter import ExternalPackageRefConverter
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.optional_utils import apply_if_present
+from spdx.jsonschema.package_properties import PackageProperty
+from spdx.jsonschema.package_verification_code_converter import PackageVerificationCodeConverter
+from spdx.model.actor import Actor
+from spdx.model.document import Document
+from spdx.model.package import Package
+from spdx.model.relationship_filters import find_package_contains_file_relationships, \
     find_file_contained_by_package_relationships
 
 

diff --git a/src/jsonschema/package_properties.py → src/spdx/jsonschema/package_properties.py b/src/jsonschema/package_properties.py → src/spdx/jsonschema/package_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class PackageProperty(JsonProperty):

diff --git a/...ma/package_verification_code_converter.py → ...ma/package_verification_code_converter.py b/...ma/package_verification_code_converter.py → ...ma/package_verification_code_converter.py
@@ -10,11 +10,11 @@
 # limitations under the License.
 from typing import Type, Any
 
-from src.jsonschema.converter import TypedConverter
-from src.jsonschema.json_property import JsonProperty
-from src.jsonschema.package_verification_code_properties import PackageVerificationCodeProperty
-from src.model.document import Document
-from src.model.package import PackageVerificationCode
+from spdx.jsonschema.converter import TypedConverter
+from spdx.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.package_verification_code_properties import PackageVerificationCodeProperty
+from spdx.model.document import Document
+from spdx.model.package import PackageVerificationCode
 
 
 class PackageVerificationCodeConverter(TypedConverter[PackageVerificationCode]):

diff --git a/...a/package_verification_code_properties.py → ...a/package_verification_code_properties.py b/...a/package_verification_code_properties.py → ...a/package_verification_code_properties.py
@@ -10,7 +10,7 @@
 # limitations under the License.
 from enum import auto
 
-from src.jsonschema.json_property import JsonProperty
+from spdx.jsonschema.json_property import JsonProperty
 
 
 class PackageVerificationCodeProperty(JsonProperty):