Add Documentation 2 (#334)

Add documentation that covers:

- configuration
- prediction

Add Python scripts that support automatic documentation generation for
configuration data defined with pydantic.

Adapt EOS configuration to provide more methods for REST API and
automatic documentation generation.

Adapt REST API to allow for EOS configuration file load and save.
Sort REST API on generation of openapi markdown for docs.

Move logutil to core/logging to allow configuration of logging by standard config.

Make Akkudoktor predictions always start extraction of prediction data at start of day.
Previously extraction started at actual hour. This is to support the code that assumes
prediction data to start at start of day.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

src/akkudoktoreos/core/logsettings.py

@@ -0,0 +1,45 @@
+"""Settings for logging.
+
+Kept in an extra module to avoid cyclic dependencies on package import.
+"""
+
+import logging
+import os
+from typing import Optional
+
+from pydantic import Field, computed_field, field_validator
+
+from akkudoktoreos.config.configabc import SettingsBaseModel
+from akkudoktoreos.core.logabc import logging_str_to_level
+
+
+class LoggingCommonSettings(SettingsBaseModel):
+    """Common settings for logging."""
+
+    logging_level_default: Optional[str] = Field(
+        default=None, description="EOS default logging level."
+    )
+
+    # Validators
+    @field_validator("logging_level_default", mode="after")
+    @classmethod
+    def set_default_logging_level(cls, value: Optional[str]) -> Optional[str]:
+        if isinstance(value, str) and value.upper() == "NONE":
+            value = None
+        if value is None and (env_level := os.getenv("EOS_LOGGING_LEVEL")) is not None:
+            # Take default logging level from special environment variable
+            value = env_level
+        if value is None:
+            return None
+        level = logging_str_to_level(value)
+        logging.getLogger().setLevel(level)
+        return value
+
+    # Computed fields
+    @computed_field  # type: ignore[prop-decorator]
+    @property
+    def logging_level_root(self) -> str:
+        """Root logger logging level."""
+        level = logging.getLogger().getEffectiveLevel()
+        level_name = logging.getLevelName(level)
+        return level_name