Improve package usability (#10)

README.md

@@ -78,12 +78,8 @@ In the end, the report generator will take the assembled *TestSuite* and generat
 A small example may look like this:
 
 ```
-# import necessary classes for the TestSuite creation
-from testguide_report_generator.model.TestSuite import TestSuite
-from testguide_report_generator.model.TestCase import TestCase, Verdict
-
-# import the .json generator
-from testguide_report_generator.ReportGenerator import Generator
+# import necessary classes for the TestSuite creation and the .json generator 
+from testguide_report_generator import TestSuite, TestCase, Verdict, Generator
 
 
 def create_testsuite():

config/license/allowlist.json

@@ -11,9 +11,9 @@
     },
     {
       "moduleLicense": "Apache-2.0",
-      "moduleVersion": "6.4.4",
+      "moduleVersion": "6.4.5",
       "moduleName": "importlib-resources",
-      "licenseUrl": "https://github.com/python/importlib_resources/blob/v6.4.4/LICENSE",
+      "licenseUrl": "https://github.com/python/importlib_resources/blob/v6.4.5/LICENSE",
       "moduleCopyright": "",
       "actualLicense": "Apache-2.0",
       "violationAllowance": ""
@@ -47,9 +47,9 @@
     },
     {
       "moduleLicense": "MIT",
-      "moduleVersion": "3.20.0",
+      "moduleVersion": "3.20.1",
       "moduleName": "zipp",
-      "licenseUrl": "https://github.com/jaraco/zipp/blob/v3.20.0/LICENSE",
+      "licenseUrl": "https://github.com/jaraco/zipp/blob/v3.20.1/LICENSE",
       "moduleCopyright": "",
       "actualLicense": "MIT",
       "violationAllowance": ""

example_TestSuite.py

@@ -6,11 +6,8 @@
 Example Script.
 """
 
-from testguide_report_generator.model.TestSuite import TestSuite
-from testguide_report_generator.model.TestCase import TestCase, TestStep, TestStepFolder, Verdict, Parameter, \
-    Direction, Review, TestStepArtifactType
-from testguide_report_generator.model.TestCaseFolder import TestCaseFolder
-from testguide_report_generator.ReportGenerator import Generator
+from testguide_report_generator import TestSuite, TestCase, TestStep, TestStepFolder, Verdict, Parameter, \
+    Direction, Review, TestStepArtifactType, TestCaseFolder, Generator
 
 
 def create_testsuite():

testguide_report_generator/__init__.py

@@ -1,3 +1,32 @@
 # Copyright (c) 2023-2024 tracetronic GmbH
 #
 # SPDX-License-Identifier: MIT
+
+"""
+This module provides essential imports for the testguide_report_generator package.
+"""
+
+from .ReportGenerator import Generator
+from .model.TestSuite import TestSuite
+from .model.TestCase import TestCase, TestStep, TestStepFolder, Verdict, Parameter, \
+    Direction, Review, TestStepArtifactType, Artifact, TestStepArtifact, Attribute
+from .model.TestCaseFolder import TestCaseFolder
+from .util.JsonValidator import JsonValidator
+
+__all__ = [
+    "Generator",
+    "TestSuite",
+    "TestCase",
+    "TestStep",
+    "TestStepFolder",
+    "Verdict",
+    "Parameter",
+    "Direction",
+    "Review",
+    "TestStepArtifactType",
+    "Artifact",
+    "TestStepArtifact",
+    "Attribute",
+    "TestCaseFolder",
+    "JsonValidator"
+]