Add review notes (#10)

- enhance imports for testguide_report_generator package
- remove imports in tests init files
- combine imports in example file

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 import TestSuite
-from testguide_report_generator import TestCase, Verdict
-
-# import the .json generator
-from testguide_report_generator 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():

example_TestSuite.py

@@ -6,11 +6,8 @@
 Example Script.
 """
 
-from testguide_report_generator import TestSuite
-from testguide_report_generator import TestCase, TestStep, TestStepFolder, Verdict, Parameter, \
-    Direction, Review, TestStepArtifactType
-from testguide_report_generator import TestCaseFolder
-from testguide_report_generator 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

@@ -3,13 +3,13 @@
 # SPDX-License-Identifier: MIT
 
 """
-This module provides essential imports for the testguide_report_generator root package.
+This module provides essential imports for the testguide_report_generator package.
 """
 
-from testguide_report_generator.ReportGenerator import Generator
+from .ReportGenerator import Generator
 from .model.TestSuite import TestSuite
 from .model.TestCase import TestCase, TestStep, TestStepFolder, Verdict, Parameter, \
-    Direction, Review, TestStepArtifactType
+    Direction, Review, TestStepArtifactType, Artifact, TestStepArtifact, Attribute
 from .model.TestCaseFolder import TestCaseFolder
 from .util.JsonValidator import JsonValidator
 
@@ -24,6 +24,9 @@
     "Direction",
     "Review",
     "TestStepArtifactType",
+    "Artifact",
+    "TestStepArtifact",
+    "Attribute",
     "TestCaseFolder",
     "JsonValidator"
 ]

testguide_report_generator/model/__init__.py

@@ -1,21 +1,3 @@
 # Copyright (c) 2023-2024 tracetronic GmbH
 #
 # SPDX-License-Identifier: MIT
-
-"""
-This module provides essential imports for the testguide_report_generator model package.
-"""
-
-from testguide_report_generator.util.Json2AtxRepr import Json2AtxRepr
-from testguide_report_generator.util.File import get_md5_hash_from_file
-from testguide_report_generator.util.ValidityChecks import check_name_length, gen_error_msg, validate_new_teststep, \
-    validate_testcase
-
-__all__ = [
-    "Json2AtxRepr",
-    "get_md5_hash_from_file",
-    "check_name_length",
-    "gen_error_msg",
-    "validate_new_teststep",
-    "validate_testcase"
-]

tests/__init__.py

@@ -1,24 +1,3 @@
 # Copyright (c) 2023-2024 tracetronic GmbH
 #
 # SPDX-License-Identifier: MIT
-
-"""
-This module provides essential imports for the tests root package.
-"""
-
-from testguide_report_generator.model.TestCase import TestCase, Verdict
-from testguide_report_generator.model.TestCaseFolder import TestCaseFolder
-from testguide_report_generator.model.TestSuite import TestSuite
-from testguide_report_generator.util.JsonValidator import JsonValidator
-from testguide_report_generator.ReportGenerator import Generator
-from testguide_report_generator.util.File import get_md5_hash_from_file
-
-__all__ = [
-    "TestCase",
-    "Verdict",
-    "TestCaseFolder",
-    "TestSuite",
-    "JsonValidator",
-    "Generator",
-    "get_md5_hash_from_file"
-]

tests/model/__init__.py

@@ -1,23 +1,3 @@
 # Copyright (c) 2023-2024 tracetronic GmbH
 #
 # SPDX-License-Identifier: MIT
-
-"""
-This module provides essential imports for the tests model package.
-"""
-
-from testguide_report_generator.model.TestCase import (TestCase, TestStep, Verdict, Artifact, TestStepArtifact,
-                                                       TestStepArtifactType)
-from testguide_report_generator.model.TestSuite import TestSuite
-from testguide_report_generator.util.ValidityChecks import gen_error_msg
-
-__all__ = [
-    "TestCase",
-    "TestStep",
-    "Verdict",
-    "Artifact",
-    "TestStepArtifact",
-    "TestStepArtifactType",
-    "TestSuite",
-    "gen_error_msg"
-]

tests/util/__init__.py

@@ -1,28 +1,3 @@
 # Copyright (c) 2023-2024 tracetronic GmbH
 #
 # SPDX-License-Identifier: MIT
-
-"""
-This module provides essential imports for the tests util package.
-"""
-
-from testguide_report_generator.model.TestCase import TestCase, TestStep, TestStepFolder
-from testguide_report_generator.model.TestCaseFolder import TestCaseFolder
-from testguide_report_generator.util.File import get_extended_windows_path, get_md5_hash_from_file
-from testguide_report_generator.util.JsonValidator import JsonValidator
-from testguide_report_generator.util.ValidityChecks import gen_error_msg, check_name_length, validate_new_teststep, \
-    validate_testcase
-
-__all__ = [
-    "TestCase",
-    "TestStep",
-    "TestStepFolder",
-    "TestCaseFolder",
-    "get_extended_windows_path",
-    "get_md5_hash_from_file",
-    "JsonValidator",
-    "gen_error_msg",
-    "check_name_length",
-    "validate_new_teststep",
-    "validate_testcase"
-]