refactor: split document renderer into a generic and a configuration based one and do a restructuring of the project

Author: micha91

capella2polarion/__main__.py

@@ -13,13 +13,9 @@
 
 from capella2polarion.cli import Capella2PolarionCli
 from capella2polarion.connectors import polarion_worker as pw
-from capella2polarion.converters import (
-    document_config,
-    document_renderer,
-    model_converter,
-    plugin_config,
-    plugin_interfaces,
-)
+from capella2polarion.documents import document_config, mass_document_renderer
+from capella2polarion.elements import model_converter
+from capella2polarion.plugins import plugin_config, plugin_interfaces
 
 logger = logging.getLogger(__name__)
 
@@ -218,7 +214,7 @@ def render_documents(
     )
 
     assert capella_to_polarion_cli.capella_model is not None
-    renderer = document_renderer.DocumentRenderer(
+    renderer = mass_document_renderer.MassDocumentRenderer(
         polarion_worker.polarion_data_repo,
         capella_to_polarion_cli.capella_model,
         capella_to_polarion_cli.polarion_params.project_id,

capella2polarion/cli.py

@@ -11,7 +11,7 @@
 import click
 
 from capella2polarion.connectors import polarion_worker as pw
-from capella2polarion.converters import converter_config
+from capella2polarion.elements import converter_config
 
 logger = logging.getLogger(__name__)
 

capella2polarion/connectors/polarion_worker.py

@@ -15,7 +15,7 @@
 
 from capella2polarion import data_model
 from capella2polarion.connectors import polarion_repo
-from capella2polarion.converters import data_session
+from capella2polarion.elements import data_session
 
 logger = logging.getLogger(__name__)
 

capella2polarion/data_model/document_data.py

@@ -8,7 +8,7 @@
 
 import polarion_rest_api_client as polarion_api
 
-from capella2polarion.converters import text_work_item_provider
+from capella2polarion.documents import text_work_item_provider
 
 __all__ = ["DocumentData", "DocumentInfo"]
 

capella2polarion/documents/__init__.py

@@ -0,0 +1,3 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+"""A package containing document generation related modules."""

…a2polarion/converters/document_config.py …la2polarion/documents/document_config.pycapella2polarion/converters/document_config.py renamed to capella2polarion/documents/document_config.py capella2polarion/converters/document_config.py renamed to capella2polarion/documents/document_config.py

@@ -12,8 +12,7 @@
 import pydantic
 import yaml
 
-from capella2polarion import data_model
-from capella2polarion.converters import polarion_html_helper
+from capella2polarion import data_model, polarion_html_helper
 
 logger = logging.getLogger(__name__)