fix: logging, prediction update, multiple bugs (#584)

* Fix logging configuration issues that made logging stop operation. Switch to Loguru
  logging (from Python logging). Enable console and file logging with different log levels.
  Add logging documentation.

* Fix logging configuration and EOS configuration out of sync. Added tracking support
  for nested value updates of Pydantic models. This used to update the logging configuration
  when the EOS configurationm for logging is changed. Should keep logging config and EOS
  config in sync as long as all changes to the EOS logging configuration are done by
  set_nested_value(), which is the case for the REST API.

* Fix energy management task looping endlessly after the second update when trying to update
  the last_update datetime.

* Fix get_nested_value() to correctly take values from the dicts in a Pydantic model instance.

* Fix usage of model classes instead of model instances in nested value access when evaluation
  the value type that is associated to each key.

* Fix illegal json format in prediction documentation for PVForecastAkkudoktor provider.

* Fix documentation qirks and add EOS Connect to integrations.

* Support deprecated fields in configuration in documentation generation and EOSdash.

* Enhance EOSdash demo to show BrightSky humidity data (that is often missing)

* Update documentation reference to German EOS installation videos.

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

src/akkudoktoreos/prediction/elecpriceabc.py

@@ -9,11 +9,8 @@ from typing import List, Optional
 
 from pydantic import Field, computed_field
 
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.predictionabc import PredictionProvider, PredictionRecord
 
-logger = get_logger(__name__)
-
 
 class ElecPriceDataRecord(PredictionRecord):
     """Represents a electricity price data record containing various price attributes at a specific datetime.

src/akkudoktoreos/prediction/elecpriceakkudoktor.py

@@ -11,17 +11,15 @@ from typing import Any, List, Optional, Union
 import numpy as np
 import pandas as pd
 import requests
+from loguru import logger
 from pydantic import ValidationError
 from statsmodels.tsa.holtwinters import ExponentialSmoothing
 
 from akkudoktoreos.core.cache import cache_in_file
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.core.pydantic import PydanticBaseModel
 from akkudoktoreos.prediction.elecpriceabc import ElecPriceProvider
 from akkudoktoreos.utils.datetimeutil import to_datetime, to_duration
 
-logger = get_logger(__name__)
-
 
 class AkkudoktorElecPriceMeta(PydanticBaseModel):
     start_timestamp: str

src/akkudoktoreos/prediction/elecpriceimport.py

@@ -9,15 +9,13 @@ format, enabling consistent access to forecasted and historical elecprice attrib
 from pathlib import Path
 from typing import Optional, Union
 
+from loguru import logger
 from pydantic import Field, field_validator
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.elecpriceabc import ElecPriceProvider
 from akkudoktoreos.prediction.predictionabc import PredictionImportProvider
 
-logger = get_logger(__name__)
-
 
 class ElecPriceImportCommonSettings(SettingsBaseModel):
     """Common settings for elecprice data import from file or JSON String."""

src/akkudoktoreos/prediction/load.py

@@ -5,13 +5,11 @@ from typing import Optional, Union
 from pydantic import Field, field_validator
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.loadabc import LoadProvider
 from akkudoktoreos.prediction.loadakkudoktor import LoadAkkudoktorCommonSettings
 from akkudoktoreos.prediction.loadimport import LoadImportCommonSettings
 from akkudoktoreos.prediction.prediction import get_prediction
 
-logger = get_logger(__name__)
 prediction_eos = get_prediction()
 
 # Valid load providers

src/akkudoktoreos/prediction/loadabc.py

@@ -9,11 +9,8 @@ from typing import List, Optional
 
 from pydantic import Field
 
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.predictionabc import PredictionProvider, PredictionRecord
 
-logger = get_logger(__name__)
-
 
 class LoadDataRecord(PredictionRecord):
     """Represents a load data record containing various load attributes at a specific datetime."""

src/akkudoktoreos/prediction/loadakkudoktor.py

@@ -3,15 +3,13 @@
 from typing import Optional
 
 import numpy as np
+from loguru import logger
 from pydantic import Field
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.loadabc import LoadProvider
 from akkudoktoreos.utils.datetimeutil import compare_datetimes, to_datetime, to_duration
 
-logger = get_logger(__name__)
-
 
 class LoadAkkudoktorCommonSettings(SettingsBaseModel):
     """Common settings for load data import from file."""

src/akkudoktoreos/prediction/loadimport.py

@@ -9,15 +9,13 @@ format, enabling consistent access to forecasted and historical load attributes.
 from pathlib import Path
 from typing import Optional, Union
 
+from loguru import logger
 from pydantic import Field, field_validator
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.loadabc import LoadProvider
 from akkudoktoreos.prediction.predictionabc import PredictionImportProvider
 
-logger = get_logger(__name__)
-
 
 class LoadImportCommonSettings(SettingsBaseModel):
     """Common settings for load data import from file or JSON string."""

src/akkudoktoreos/prediction/predictionabc.py

@@ -10,6 +10,7 @@ and manipulation of configuration and prediction data in a clear, scalable, and
 
 from typing import List, Optional
 
+from loguru import logger
 from pendulum import DateTime
 from pydantic import Field, computed_field
 
@@ -22,11 +23,8 @@ from akkudoktoreos.core.dataabc import (
     DataRecord,
     DataSequence,
 )
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.utils.datetimeutil import to_duration
 
-logger = get_logger(__name__)
-
 
 class PredictionBase(DataBase, MeasurementMixin):
     """Base class for handling prediction data.

src/akkudoktoreos/prediction/pvforecast.py

@@ -5,13 +5,11 @@ from typing import Any, List, Optional, Self
 from pydantic import Field, computed_field, field_validator, model_validator
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.prediction import get_prediction
 from akkudoktoreos.prediction.pvforecastabc import PVForecastProvider
 from akkudoktoreos.prediction.pvforecastimport import PVForecastImportCommonSettings
 from akkudoktoreos.utils.docs import get_model_structure_from_examples
 
-logger = get_logger(__name__)
 prediction_eos = get_prediction()
 
 # Valid PV forecast providers

src/akkudoktoreos/prediction/pvforecastabc.py

@@ -7,13 +7,11 @@ Notes:
 from abc import abstractmethod
 from typing import List, Optional
 
+from loguru import logger
 from pydantic import Field
 
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.predictionabc import PredictionProvider, PredictionRecord
 
-logger = get_logger(__name__)
-
 
 class PVForecastDataRecord(PredictionRecord):
     """Represents a pvforecast data record containing various pvforecast attributes at a specific datetime."""

src/akkudoktoreos/prediction/pvforecastakkudoktor.py

@@ -78,10 +78,10 @@ Methods:
 from typing import Any, List, Optional, Union
 
 import requests
+from loguru import logger
 from pydantic import Field, ValidationError, computed_field, field_validator
 
 from akkudoktoreos.core.cache import cache_in_file
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.core.pydantic import PydanticBaseModel
 from akkudoktoreos.prediction.pvforecastabc import (
     PVForecastDataRecord,
@@ -89,8 +89,6 @@ from akkudoktoreos.prediction.pvforecastabc import (
 )
 from akkudoktoreos.utils.datetimeutil import compare_datetimes, to_datetime
 
-logger = get_logger(__name__)
-
 
 class AkkudoktorForecastHorizon(PydanticBaseModel):
     altitude: int

src/akkudoktoreos/prediction/pvforecastimport.py

@@ -9,15 +9,13 @@ format, enabling consistent access to forecasted and historical pvforecast attri
 from pathlib import Path
 from typing import Optional, Union
 
+from loguru import logger
 from pydantic import Field, field_validator
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.predictionabc import PredictionImportProvider
 from akkudoktoreos.prediction.pvforecastabc import PVForecastProvider
 
-logger = get_logger(__name__)
-
 
 class PVForecastImportCommonSettings(SettingsBaseModel):
     """Common settings for pvforecast data import from file or JSON string."""

src/akkudoktoreos/prediction/weatherabc.py

@@ -14,11 +14,8 @@ import pandas as pd
 import pvlib
 from pydantic import Field
 
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.predictionabc import PredictionProvider, PredictionRecord
 
-logger = get_logger(__name__)
-
 
 class WeatherDataRecord(PredictionRecord):
     """Represents a weather data record containing various weather attributes at a specific datetime.

src/akkudoktoreos/prediction/weatherbrightsky.py

@@ -13,15 +13,12 @@ import numpy as np
 import pandas as pd
 import pvlib
 import requests
+from loguru import logger
 
 from akkudoktoreos.core.cache import cache_in_file
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.weatherabc import WeatherDataRecord, WeatherProvider
 from akkudoktoreos.utils.datetimeutil import to_datetime, to_duration
 
-logger = get_logger(__name__)
-
-
 WheaterDataBrightSkyMapping: List[Tuple[str, Optional[str], Optional[Union[str, float]]]] = [
     # brightsky_key, description, corr_factor
     ("timestamp", "DateTime", "to datetime in timezone"),

src/akkudoktoreos/prediction/weatherclearoutside.py

@@ -18,15 +18,12 @@ from typing import Dict, List, Optional, Tuple
 import pandas as pd
 import requests
 from bs4 import BeautifulSoup
+from loguru import logger
 
 from akkudoktoreos.core.cache import cache_in_file
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.weatherabc import WeatherDataRecord, WeatherProvider
 from akkudoktoreos.utils.datetimeutil import to_datetime, to_duration, to_timezone
 
-logger = get_logger(__name__)
-
-
 WheaterDataClearOutsideMapping: List[Tuple[str, Optional[str], Optional[float]]] = [
     # clearoutside_key, description, corr_factor
     ("DateTime", "DateTime", None),

src/akkudoktoreos/prediction/weatherimport.py

@@ -9,15 +9,13 @@ format, enabling consistent access to forecasted and historical weather attribut
 from pathlib import Path
 from typing import Optional, Union
 
+from loguru import logger
 from pydantic import Field, field_validator
 
 from akkudoktoreos.config.configabc import SettingsBaseModel
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.prediction.predictionabc import PredictionImportProvider
 from akkudoktoreos.prediction.weatherabc import WeatherProvider
 
-logger = get_logger(__name__)
-
 
 class WeatherImportCommonSettings(SettingsBaseModel):
     """Common settings for weather data import from file or JSON string."""