dsp-tools 9.1.0.post11__py3-none-any.whl → 18.3.0.post13__py3-none-any.whl

dsp_tools/cli/create_parsers.py

@@ -32,6 +32,7 @@ def make_parser(
     parser = ArgumentParser(
         description=f"DSP-TOOLS (version {version('dsp-tools')}, © {datetime.datetime.now().year} by DaSCH)"
     )
+    parser.add_argument("--version", action="store_true", help="print the installed and latest verison of dsp-tools")
     subparsers = parser.add_subparsers(
         title="Subcommands", description="Valid subcommands are", help="sub-command help"
     )
@@ -46,7 +47,7 @@ def make_parser(
 
     _add_xmlupload(subparsers, default_dsp_api_url, root_user_email, root_user_pw)
 
-    _add_xml_validate(subparsers, default_dsp_api_url)
+    _add_validate_data(subparsers, default_dsp_api_url, root_user_email, root_user_pw)
 
     _add_resume_xmlupload(subparsers, default_dsp_api_url, root_user_email, root_user_pw)
 
@@ -54,23 +55,19 @@ def make_parser(
     _add_ingest_files(subparsers, default_dsp_api_url, root_user_email, root_user_pw)
     _add_ingest_xmlupload(subparsers, default_dsp_api_url, root_user_email, root_user_pw)
 
-    _add_new_excel2json(subparsers)
     _add_excel2json(subparsers)
+    _add_old_excel2json(subparsers)
 
-    _add_new_excel2lists(subparsers)
     _add_excel2lists(subparsers)
+    _add_old_excel2lists(subparsers)
 
     _add_excel2resources(subparsers)
 
     _add_excel2properties(subparsers)
 
-    _add_excel2xml(subparsers)
-
     _add_id2iri(subparsers)
 
-    _add_create_template(subparsers)
-
-    _add_rosetta(subparsers)
+    _add_update_legal(subparsers)
 
     _add_suppress_update_prompt(subparsers)
 
@@ -86,21 +83,6 @@ def _add_suppress_update_prompt(subparsers: _SubParsersAction[ArgumentParser]) -
         sp.add_argument("--suppress-update-prompt", action="store_true", help=outdated_help_text)
 
 
-def _add_rosetta(subparsers: _SubParsersAction[ArgumentParser]) -> None:
-    subparser = subparsers.add_parser(
-        name="rosetta", help="Clone the most up to data rosetta repository, create the data model and upload the data"
-    )
-    subparser.set_defaults(action="rosetta")
-
-
-def _add_create_template(subparsers: _SubParsersAction[ArgumentParser]) -> None:
-    # create template repo with minimal JSON and XML files
-    subparser = subparsers.add_parser(
-        name="template", help="Create a template repository with a minimal JSON and XML file"
-    )
-    subparser.set_defaults(action="template")
-
-
 def _add_stop_stack(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser = subparsers.add_parser(
         name="stop-stack", help="Shut down the local instance of DSP-API and DSP-APP, and delete all data in it"
@@ -117,6 +99,7 @@ def _add_start_stack(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     max_file_size_text = "max. multimedia file size allowed for ingest, in MB (default: 2000, max: 100'000)"
     no_prune_text = "don't execute 'docker system prune' (and don't ask)"
     with_test_data_text = "initialise the database with built-in test data"
+    custom_host = "set a host to an IP or a domain to run the instance on a server"
     subparser = subparsers.add_parser(name="start-stack", help="Run a local instance of DSP-API and DSP-APP")
     subparser.set_defaults(action="start-stack")
     subparser.add_argument("--max_file_size", type=int, help=max_file_size_text)
@@ -124,7 +107,7 @@ def _add_start_stack(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser.add_argument("--no-prune", action="store_true", help=no_prune_text)
     subparser.add_argument("--latest", action="store_true", help=latest_text)
     subparser.add_argument("--with-test-data", action="store_true", help=with_test_data_text)
-    subparser.add_argument("--validation", action="store_true")
+    subparser.add_argument("--custom-host", default=None, type=str, help=custom_host)
 
 
 def _add_id2iri(subparsers: _SubParsersAction[ArgumentParser]) -> None:
@@ -140,17 +123,6 @@ def _add_id2iri(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser.add_argument("mapping", help="path to the JSON file containing the mapping of IDs to IRIs")
 
 
-def _add_excel2xml(subparsers: _SubParsersAction[ArgumentParser]) -> None:
-    subparser = subparsers.add_parser(
-        name="excel2xml",
-        help="Create an XML file from an Excel/CSV file that is already structured according to the DSP specifications",
-    )
-    subparser.set_defaults(action="excel2xml")
-    subparser.add_argument("data_source", help="path to the CSV or XLS(X) file containing the data")
-    subparser.add_argument("project_shortcode", help="shortcode of the project that this data belongs to")
-    subparser.add_argument("ontology_name", help="name of the ontology that this data belongs to")
-
-
 def _add_excel2properties(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser = subparsers.add_parser(
         name="excel2properties",
@@ -173,43 +145,43 @@ def _add_excel2resources(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser.add_argument("resources_section", help="path to the output JSON file containing the 'resources' section")
 
 
-def _add_new_excel2lists(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+def _add_excel2lists(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser = subparsers.add_parser(
-        name="new-excel2lists",
+        name="excel2lists",
         help="Create the 'lists' section of a JSON project file from one or multiple Excel files",
     )
-    subparser.set_defaults(action="new-excel2lists")
+    subparser.set_defaults(action="excel2lists")
     subparser.add_argument("excelfolder", help="path to the folder containing the Excel file(s)")
     subparser.add_argument("lists_section", help="path to the output JSON file containing the 'lists' section")
 
 
-def _add_excel2lists(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+def _add_old_excel2lists(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser = subparsers.add_parser(
-        name="excel2lists",
-        help="Create the 'lists' section of a JSON project file from one or multiple Excel files",
+        name="old-excel2lists",
+        help="DEPRECATED: Create the 'lists' section of a JSON project file from one or multiple Excel files",
     )
-    subparser.set_defaults(action="excel2lists")
+    subparser.set_defaults(action="old-excel2lists")
     subparser.add_argument("-v", "--verbose", action="store_true", help=verbose_text)
     subparser.add_argument("excelfolder", help="path to the folder containing the Excel file(s)")
     subparser.add_argument("lists_section", help="path to the output JSON file containing the 'lists' section")
 
 
-def _add_excel2json(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+def _add_old_excel2json(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser = subparsers.add_parser(
-        name="excel2json",
-        help="Create an entire JSON project file from a folder containing the required Excel files",
+        name="old-excel2json",
+        help="DEPRECATED: Create an entire JSON project file from a folder containing the required Excel files",
     )
-    subparser.set_defaults(action="excel2json")
+    subparser.set_defaults(action="old-excel2json")
     subparser.add_argument("excelfolder", help="path to the folder containing the Excel files")
     subparser.add_argument("project_definition", help="path to the output JSON file")
 
 
-def _add_new_excel2json(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+def _add_excel2json(subparsers: _SubParsersAction[ArgumentParser]) -> None:
     subparser = subparsers.add_parser(
-        name="new-excel2json",
+        name="excel2json",
         help="Create an entire JSON project file from a folder containing the required Excel files",
     )
-    subparser.set_defaults(action="new-excel2json")
+    subparser.set_defaults(action="excel2json")
     subparser.add_argument("excelfolder", help="path to the folder containing the Excel files")
     subparser.add_argument("project_definition", help="path to the output JSON file")
 
@@ -267,6 +239,29 @@ def _add_ingest_xmlupload(
     subparser.add_argument("-p", "--password", default=root_user_pw, help=password_text)
     subparser.add_argument("--interrupt-after", type=int, default=-1, help="interrupt after this number of resources")
     subparser.add_argument("xml_file", help="path to XML file containing the data")
+    subparser.add_argument("--skip-validation", action="store_true", help="Skip the SHACL schema validation")
+    subparser.add_argument(
+        "--skip-ontology-validation",
+        action="store_true",
+        help=(
+            "don't validate the data model itself, only the data. "
+            "This is intended for projects that are already on the production server"
+        ),
+    )
+    subparser.add_argument(
+        "--id2iri-file",
+        help=(
+            "replaces internal IDs of an XML file (links and stand-off links inside richtext) "
+            "by IRIs provided in this mapping file"
+        ),
+    )
+    subparser.add_argument(
+        "--do-not-request-resource-metadata-from-db",
+        action="store_true",
+        help=(
+            "Do not request IRIs of existing resources from the db (references to existing resources won't be checked)"
+        ),
+    )
 
 
 def _add_xmlupload(
@@ -286,26 +281,104 @@ def _add_xmlupload(
         "-i", "--imgdir", default=".", help="folder from where the paths in the <bitstream> tags are evaluated"
     )
     subparser.add_argument(
-        "-V", "--validate-only", action="store_true", help="validate the XML file without uploading it"
+        "-V", "--validate-only", action="store_true", help="run the XML Schema validation without uploading the XML"
+    )
+    subparser.add_argument("--skip-validation", action="store_true", help="Skip the SHACL schema validation")
+    subparser.add_argument(
+        "--skip-ontology-validation",
+        action="store_true",
+        help=(
+            "don't validate the data model itself, only the data. "
+            "This is intended for projects that are already on the production server"
+        ),
     )
     subparser.add_argument("--interrupt-after", type=int, default=-1, help="interrupt after this number of resources")
     subparser.add_argument("xmlfile", help="path to the XML file containing the data")
-    subparser.add_argument("--no-iiif-uri-validation", action="store_true", help="skip the IIIF URI validation")
+    subparser.add_argument(
+        "--no-iiif-uri-validation",
+        action="store_true",
+        help="don't check if the IIIF links are valid URLs that can be reached online",
+    )
+    subparser.add_argument(
+        "--ignore-duplicate-files-warning",
+        action="store_true",
+        help="don't check if multimedia files are referenced more than once",
+    )
+    subparser.add_argument(
+        "--validation-severity",
+        choices=["error", "warning", "info"],
+        help=(
+            "Which severity level of validation message should be printed out. "
+            "Each level of severity includes the higher levels."
+        ),
+        default="info",
+    )
+    subparser.add_argument(
+        "--do-not-request-resource-metadata-from-db",
+        action="store_true",
+        help=(
+            "Do not request IRIs of existing resources from the db (references to existing resources won't be checked)"
+        ),
+    )
+    subparser.add_argument(
+        "--id2iri-file",
+        help=(
+            "replaces internal IDs of an XML file (links and stand-off links inside richtext) "
+            "by IRIs provided in this mapping file"
+        ),
+    )
 
 
-def _add_xml_validate(
+def _add_validate_data(
     subparsers: _SubParsersAction[ArgumentParser],
     default_dsp_api_url: str,
+    root_user_email: str,
+    root_user_pw: str,
 ) -> None:
-    subparser = subparsers.add_parser(name="xml-validate", help="Validate the data with the data model.")
-    subparser.set_defaults(action="xml-validate")
+    subparser = subparsers.add_parser(
+        name="validate-data", help="Validate the data against the data model previously uploaded on the server."
+    )
+    subparser.set_defaults(action="validate-data")
     subparser.add_argument("xmlfile", help="path to the XML file containing the data")
+    subparser.add_argument("-u", "--user", default=root_user_email, help=username_text)
+    subparser.add_argument("-p", "--password", default=root_user_pw, help=password_text)
     subparser.add_argument(
-        "-s", "--server", default=default_dsp_api_url, help="URL of the DSP server where DSP-TOOLS sends the data to"
+        "--ignore-duplicate-files-warning",
+        action="store_true",
+        help="don't check if multimedia files are referenced more than once",
     )
-    subparser.add_argument("--dev", action="store_true", help="Validate with experimental features.")
     subparser.add_argument(
-        "--save-graphs", action="store_true", help="Save the data, onto and shacl graph as ttl files."
+        "--skip-ontology-validation",
+        action="store_true",
+        help=(
+            "don't validate the data model itself, only the data. "
+            "This is intended for projects that are already on the production server"
+        ),
+    )
+    subparser.add_argument(
+        "-s",
+        "--server",
+        default=default_dsp_api_url,
+        help="URL of the DSP server where DSP-TOOLS gets the data model from",
+    )
+    subparser.add_argument(
+        "--id2iri-file",
+        help=(
+            "replaces internal IDs of an XML file (links and stand-off links inside richtext) "
+            "by IRIs provided in this mapping file"
+        ),
+    )
+    subparser.add_argument(
+        "--do-not-request-resource-metadata-from-db",
+        action="store_true",
+        help=(
+            "Do not request IRIs of existing resources from the db (references to existing resources won't be checked)"
+        ),
+    )
+    subparser.add_argument(
+        "--save-graphs",
+        action="store_true",
+        help="Save the data, onto and shacl graph as ttl files. This is primarily intended for development use.",
     )
 
 
@@ -365,6 +438,11 @@ def _add_create(
     subparser.add_argument("-s", "--server", default=default_dsp_api_url, help=dsp_server_text)
     subparser.add_argument("-u", "--user", default=root_user_email, help=username_text)
     subparser.add_argument("-p", "--password", default=root_user_pw, help=password_text)
+    subparser.add_argument(
+        "--exit-if-exists",
+        action="store_true",
+        help="exit gracefully without further uploads if the project already exists",
+    )
     subparser.add_argument(
         "-V",
         "--validate-only",
@@ -377,5 +455,25 @@ def _add_create(
         action="store_true",
         help="create only the lists (prerequisite: the project exists on the server)",
     )
-    subparser.add_argument("-v", "--verbose", action="store_true", help=verbose_text)
     subparser.add_argument("project_definition", help="path to the JSON project file")
+
+
+def _add_update_legal(subparsers: _SubParsersAction[ArgumentParser]) -> None:
+    subparser = subparsers.add_parser(
+        name="update-legal",
+        help="Convert the legal metadata of an XML file from text properties to bitstream attributes",
+    )
+    subparser.set_defaults(action="update-legal")
+    subparser.add_argument("--authorship_prop", type=str, help="Property used for the authorship, e.g. ':hasAuthor'")
+    subparser.add_argument("--copyright_prop", type=str, help="Property used for the copyright, e.g. ':hasCopyright'")
+    subparser.add_argument("--license_prop", type=str, help="Property used for the license, e.g. ':hasLicense'")
+    subparser.add_argument("--authorship_default", type=str, help="Default authorship value when property is missing")
+    subparser.add_argument("--copyright_default", type=str, help="Default copyright value when property is missing")
+    subparser.add_argument("--license_default", type=str, help="Default license value when property is missing")
+    subparser.add_argument("--fixed_errors", type=str, help="Path to the CSV file with corrected legal metadata values")
+    subparser.add_argument(
+        "--treat-invalid-licenses-as-unknown",
+        action="store_true",
+        help="Treat invalid licenses as 'unknown' instead of creating FIXME entries",
+    )
+    subparser.add_argument("xmlfile", help="path to the XML file containing the data")

dsp_tools/cli/entry_point.py

@@ -5,21 +5,24 @@ The code in this file handles the arguments passed by the user from the command
 import argparse
 import subprocess
 import sys
+from collections.abc import Sequence
 from importlib.metadata import version
 
 import regex
 import requests
 from loguru import logger
+from packaging.version import Version
 from packaging.version import parse
-from termcolor import colored
 
 from dsp_tools.cli.call_action import call_requested_action
 from dsp_tools.cli.create_parsers import make_parser
-from dsp_tools.models.exceptions import BaseError
-from dsp_tools.models.exceptions import InternalError
-from dsp_tools.models.exceptions import UserError
-from dsp_tools.utils.logger_config import logger_config
-from dsp_tools.utils.warnings_config import initialize_warnings
+from dsp_tools.config.logger_config import logger_config
+from dsp_tools.config.warnings_config import initialize_warnings
+from dsp_tools.error.exceptions import BaseError
+from dsp_tools.error.exceptions import InputError
+from dsp_tools.error.exceptions import InternalError
+from dsp_tools.utils.ansi_colors import BOLD_RED
+from dsp_tools.utils.ansi_colors import RESET_TO_DEFAULT
 
 
 def main() -> None:
@@ -30,7 +33,7 @@ def main() -> None:
     run(sys.argv[1:])
 
 
-def run(args: list[str]) -> None:
+def run(args: Sequence[str]) -> None:
     """
     Main function of the CLI.
 
@@ -39,7 +42,6 @@ def run(args: list[str]) -> None:
             excluding the leading "dsp-tools" command.
 
     Raises:
-        UserError: if user input was wrong
         InputError: if user input was wrong
         InternalError: if the user cannot fix it
     """
@@ -70,14 +72,13 @@ def run(args: list[str]) -> None:
         )
         success = call_requested_action(parsed_arguments)
     except BaseError as err:
-        logger.exception("The process was terminated because of an Error:")
-        print("\nThe process was terminated because of an Error:")
-        print(err.message)
-        sys.exit(1)
+        logger.exception(f"The process was terminated because of an Error: {err.message}")
+        print(f"\n{BOLD_RED}The process was terminated because of an Error: {err.message}{RESET_TO_DEFAULT}")
+        success = False
     except Exception as err:  # noqa: BLE001 (blind-except)
         logger.exception(err)
         print(InternalError())
-        sys.exit(1)
+        success = False
 
     if not success:
         logger.error("Terminate without success")
@@ -92,14 +93,10 @@ def _check_version() -> None:
     If the base version (i.e. the major.minor.micro part of the version) is outdated,
     ask the user if they want to exit or continue anyway.
     """
-    try:
-        response = requests.get("https://pypi.org/pypi/dsp-tools/json", timeout=5)
-    except (requests.ConnectionError, requests.ReadTimeout):
+    versioning_result = _get_dsp_tools_versions()
+    if not versioning_result:
         return
-    if not response.ok:
-        return
-    latest = parse(response.json()["info"]["version"])
-    installed = parse(version("dsp-tools"))
+    installed, latest = versioning_result
     if latest <= installed:  # in the release-please PR, the installed version is always greater than the latest
         return
 
@@ -108,24 +105,54 @@ def _check_version() -> None:
         "Consider upgrading via 'pip3 install --upgrade dsp-tools'.\n"
     )
     if latest.base_version == installed.base_version:
-        print(colored(msg, color="red"))
+        print(BOLD_RED + msg + RESET_TO_DEFAULT)
         return
 
     msg += "Continue anyway? [y/n]"
     resp = None
     while resp not in ["y", "n"]:
-        resp = input(colored(msg, color="red"))
+        resp = input(BOLD_RED + msg + RESET_TO_DEFAULT)
     if resp == "y":
         return
     sys.exit(1)
 
 
+def _get_dsp_tools_versions() -> tuple[Version, Version] | None:
+    try:
+        response = requests.get("https://pypi.org/pypi/dsp-tools/json", timeout=5)
+    except (requests.ConnectionError, requests.ReadTimeout):
+        return None
+    if not response.ok:
+        return None
+    latest = parse(response.json()["info"]["version"])
+    installed = parse(version("dsp-tools"))
+    return installed, latest
+
+
+def _print_version_info() -> None:
+    """
+    Print version information including installed version and latest available version from PyPI.
+    If PyPI cannot be reached, only print the installed version.
+    """
+    installed_version = version("dsp-tools")
+    print(f"DSP-TOOLS version {installed_version}")
+
+    versioning_result = _get_dsp_tools_versions()
+    if versioning_result:
+        installed, latest = versioning_result
+        if latest > installed:
+            print(f"Latest version available: {latest}")
+        elif latest == installed:
+            print("You are using the latest version")
+
+
 def _parse_arguments(
-    user_args: list[str],
+    user_args: Sequence[str],
     parser: argparse.ArgumentParser,
 ) -> argparse.Namespace:
     """
     Parse the user-provided CLI arguments.
+    If --version flag is provided, print version information and exit.
     If no action is provided,
     print the help text and exit with error code 1.
 
@@ -137,6 +164,9 @@ def _parse_arguments(
         parsed arguments
     """
     args = parser.parse_args(user_args)
+    if hasattr(args, "version") and args.version:
+        _print_version_info()
+        sys.exit(0)
     if not hasattr(args, "action"):
         parser.print_help(sys.stderr)
         sys.exit(1)
@@ -225,7 +255,7 @@ def _get_canonical_server_and_dsp_ingest_url(
         default_dsp_ingest_url: default ingest server on localhost
 
     Raises:
-        UserError: if the DSP server URL passed by the user is invalid
+        InputError: if the DSP server URL passed by the user is invalid
 
     Returns:
         canonical DSP URL and ingest server URL
@@ -243,7 +273,7 @@ def _get_canonical_server_and_dsp_ingest_url(
         dsp_ingest_url = f"https://ingest.{remote_url_match.group(1)}.swiss"
     else:
         logger.error(f"Invalid DSP server URL '{server}'")
-        raise UserError(f"ERROR: Invalid DSP server URL '{server}'")
+        raise InputError(f"ERROR: Invalid DSP server URL '{server}'")
 
     logger.info(f"Using DSP server '{server}' and ingest server '{dsp_ingest_url}'")
     print(f"Using DSP server '{server}' and ingest server '{dsp_ingest_url}'")
@@ -268,7 +298,7 @@ def _derive_dsp_ingest_url(
         default_dsp_ingest_url: default ingest server on localhost
 
     Raises:
-        UserError: if the DSP server URL passed by the user is invalid
+        InputError: if the DSP server URL passed by the user is invalid
 
     Returns:
         the modified arguments

dsp_tools/cli/utils.py

@@ -0,0 +1,87 @@
+import argparse
+import subprocess
+from pathlib import Path
+
+import requests
+from loguru import logger
+
+from dsp_tools.cli.args import NetworkRequirements
+from dsp_tools.cli.args import PathDependencies
+from dsp_tools.cli.args import ServerCredentials
+from dsp_tools.error.exceptions import DockerNotReachableError
+from dsp_tools.error.exceptions import DspApiNotReachableError
+from dsp_tools.error.exceptions import UserDirectoryNotFoundError
+from dsp_tools.error.exceptions import UserFilepathNotFoundError
+
+LOCALHOST_API = "http://0.0.0.0:3333"
+
+
+def get_creds(args: argparse.Namespace) -> ServerCredentials:
+    return ServerCredentials(
+        server=args.server,
+        user=args.user,
+        password=args.password,
+        dsp_ingest_url=args.dsp_ingest_url,
+    )
+
+
+def check_input_dependencies(
+    paths: PathDependencies | None = None, network_dependencies: NetworkRequirements | None = None
+) -> None:
+    if paths:
+        check_path_dependencies(paths)
+    if network_dependencies:
+        _check_network_health(network_dependencies)
+
+
+def check_path_dependencies(paths: PathDependencies) -> None:
+    for f_path in paths.required_files:
+        _check_filepath_exists(f_path)
+    for dir_path in paths.required_directories:
+        _check_directory_exists(dir_path)
+
+
+def _check_filepath_exists(file_path: Path) -> None:
+    if not file_path.exists():
+        raise UserFilepathNotFoundError(file_path)
+
+
+def _check_directory_exists(dir_path: Path) -> None:
+    if not dir_path.is_dir():
+        raise UserDirectoryNotFoundError(dir_path)
+
+
+def _check_network_health(network_requirements: NetworkRequirements) -> None:
+    if network_requirements.api_url == LOCALHOST_API or network_requirements.always_requires_docker:
+        check_docker_health()
+    _check_api_health(network_requirements.api_url)
+
+
+def check_docker_health() -> None:
+    if subprocess.run("docker stats --no-stream".split(), check=False, capture_output=True, timeout=3).returncode != 0:
+        raise DockerNotReachableError()
+
+
+def _check_api_health(api_url: str) -> None:
+    health_url = f"{api_url}/health"
+    msg = (
+        "The DSP-API could not be reached. Please check if your stack is healthy "
+        "or start a stack with 'dsp-tools start-stack' if none is running."
+    )
+    try:
+        response = requests.get(health_url, timeout=2)
+        if not response.ok:
+            if api_url != LOCALHOST_API:
+                msg = (
+                    f"The DSP-API could not be reached (returned status {response.status_code}). "
+                    f"Please contact the DaSCH engineering team for help."
+                )
+            logger.error(msg)
+            raise DspApiNotReachableError(msg)
+        logger.debug(f"DSP API health check passed: {health_url}")
+    except requests.exceptions.RequestException as e:
+        logger.error(e)
+        if api_url != LOCALHOST_API:
+            msg = "The DSP-API responded with a request exception. Please contact the DaSCH engineering team for help."
+        logger.error(msg)
+        raise DspApiNotReachableError(msg) from None