Read MQTT password from file (#11)

* Add a documentation on how to contribute to the project

* add a docker compose example

* enhance copyright year

* new version, description of new variable MQTT_PASSWORD_FILE and more unit test documentation

* increase version

* fixing ruff command

* optimize code validation pipeline

* clean up requirements and optimize code test pipeline

* make python doc more useable, increase version, implement new feature to read mqtt password from file, clean up code in main block

Author: cybcon

.github/workflows/code-validation.yaml

@@ -22,8 +22,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install ruff pytest
           pip install -r ./src/requirements.txt
+          pip install -r ./test/requirements.txt
       - name: Lint with ruff
         run: |
           # stop the build if there are Python syntax errors or undefined names

CONTRIBUTING.md

@@ -1,9 +1,46 @@
-https://docs.github.com/articles/setting-guidelines-for-repository-contributors/
-# Contributing Guidelines
-
-## Basic guidelines
-- Commits needs to have a valid GPG signature
-- If using 3rd party components, the licence needs to be compatible with the license of this project
-- Pull requests should describe the content of the code
-- All pull request checks have to pass successfully
--
+## How to contribute to weather2mqtt
+
+#### **Did you find a bug?**
+
+* **Do not open up a GitHub issue if the bug is a security vulnerability
+  in weather2mqtt**, and instead write me a mail to [info@oberdorf-itc.de](mailto:info@oberdorf-itc.de).
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/cybcon/docker.weather2mqtt/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/cybcon/docker.weather2mqtt/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* All commits needs to have a valid GPG signature
+
+* All pull request checks have to pass successfully
+
+* If using 3rd party components, the licence needs to be compatible with the license of this project
+
+#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the application will generally not be accepted.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the new feature or the change. Include the relevant issue number if applicable.
+
+* All commits needs to have a valid GPG signature
+
+* All pull request checks have to pass successfully
+
+* If using 3rd party components, the licence needs to be compatible with the license of this project
+
+#### **Do you have questions about the source code?**
+
+* Write me a mail to [info@oberdorf-itc.de](mailto:info@oberdorf-itc.de).
+
+Thanks! :heart: :heart: :heart:
+
+Michael

Dockerfile

@@ -1,7 +1,7 @@
 FROM alpine:3.23.2
 
 LABEL maintainer="Michael Oberdorf <info@oberdorf-itc.de>"
-LABEL site.local.program.version="1.0.2"
+LABEL site.local.program.version="1.1.0"
 
 ENV TZ="UTC" \
     REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt \

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Michael Oberdorf IT-Consulting
+Copyright (c) 2025-2026 Michael Oberdorf IT-Consulting
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -26,7 +26,8 @@ Container image: [DockerHub](https://hub.docker.com/r/oitc/weather2mqtt)
 
 # Supported tags and respective `Dockerfile` links
 
-* [`latest`, `1.0.2`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.0.2/Dockerfile)
+* [`latest`, `1.1.0`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.1.0/Dockerfile)
+* [`1.0.2`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.0.2/Dockerfile)
 * [`1.0.0`](https://github.com/cybcon/docker.weather2mqtt/blob/v1.0.0/Dockerfile)
 
 # Summary
@@ -129,6 +130,7 @@ The container grab some configuration via environment variables.
 | `REQUESTS_CA_BUNDLE`         | Path to certificates of trusted certificate authorities.                         | optional     | `/etc/ssl/certs/ca-certificates.crt` |
 | `MQTT_USERNAME`              | Username to authenticate to MQTT broker.                                         | optional     |               |
 | `MQTT_PASSWORD`              | Password to authenticate to MQTT broker.                                         | optional     |               |
+| `MQTT_PASSWORD_FILE`         | File that contains the password to authenticate to MQTT broker.                  | optional     |               |
 | `MQTT_SERVER`                | MQTT broker hostname to connect to.                                              | optional     | `test.mosquitto.org` |
 | `MQTT_PORT`                  | MQTT broker TCP port to connect to.                                              | optional     | `1883`        |
 | `MQTT_RETAIN`                | Publish MQTT message in retain mode fpr persistance.                             | optional     | `false`       |
@@ -139,14 +141,15 @@ The container grab some configuration via environment variables.
 
 ### .envrc example
 
+If you use `direnv` to load your environment automatically.
+
 ```bash
 export TZ="Europe/Berlin"
 export REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt
 export DEBUG="true"
 export MODE="current"
-export LATITUDE="48.7801"
-export LONGITUDE="8.9321"
-export ELEVATION="409.0"
+export LATITUDE="48.72592"
+export LONGITUDE="9.11446"
 export WEATHER_MODELS="icon_d2"
 export MQTT_SERVER="test.mosquitto.org"
 export MQTT_PORT="8883"
@@ -178,12 +181,16 @@ To trigger the Python unit tests please follow following instrructions after che
 
 ```bash
 pip install -r src/requirements.txt
+pip install -r test/requirements.txt
 ```
 
 ### Execute Unit Tests
 
 ```bash
 python -m unittest
+pytest
+ruff check --select=E9,F63,F7,F82 --target-version=py312 .
+ruff check --target-version=py312 .
 ```
 
 # Donate
@@ -193,7 +200,7 @@ I would appreciate a small donation to support the further development of my ope
 
 # License
 
-Copyright (c) 2025 Michael Oberdorf IT-Consulting
+Copyright (c) 2025-2026 Michael Oberdorf IT-Consulting
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docker-compose.yaml

@@ -0,0 +1,20 @@
+services:
+  weather2mqtt:
+    container_name: weater2mqtt
+    image: oitc/weather2mqtt:latest
+    restart: "no"
+    user: 3985:3985
+    environment:
+      TZ: Europe/Berlin
+      DEBUG: true
+      MODE: current
+      LATITUDE: 48.72592
+      LONGITUDE: 9.11446
+      WEATHER_MODELS: icon_d2
+      MQTT_SERVER: test.mosquitto.org
+      MQTT_PORT: 8883
+      MQTT_TLS: true
+      MQTT_TLS_INSECURE: false
+      MQTT_PROTOCOL_VERSION: 5
+      MQTT_TOPIC: github.com/cybcon/docker.weather2mqtt.git/weather
+      CACHE_EXPIRY_AFTER_SEC: 10

src/app/bin/weather2mqtt.py

@@ -1,18 +1,18 @@
 """
 ###############################################################################
-# Tool to get weather information from the Open-Meteo API and publish it to MQTT\n
-# seeAlso: https://open-meteo.com/en/docs\n
-#------------------------------------------------------------------------------\n
-# This is a Hackergarden project, started during 50th Hackergarden 2025-04-01\n
-# at codecentric AG, Industriestraße 3, 70565 Stuttgart, Germany\n
-# seeAlso: https://www.hackergarten.net/\n
-# seeAlso: https://www.codecentric.de/standorte/stuttgart\n
-#------------------------------------------------------------------------------\n
-# Author: Michael Oberdorf\n
-# Date: 2025-04-11\n
-# Last modified by: Michael Oberdorf\n
-# Last modified at: 2025-12-31\n
-###############################################################################\n
+# Tool to get weather information from the Open-Meteo API and publish it to MQTT
+# seeAlso: https://open-meteo.com/en/docs
+#------------------------------------------------------------------------------
+# This is a Hackergarden project, started during 50th Hackergarden 2025-04-01
+# at codecentric AG, Industriestraße 3, 70565 Stuttgart, Germany
+# seeAlso: https://www.hackergarten.net/
+# seeAlso: https://www.codecentric.de/standorte/stuttgart
+#------------------------------------------------------------------------------
+# Author: Michael Oberdorf
+# Date: 2025-04-11
+# Last modified by: Michael Oberdorf
+# Last modified at: 2026-01-01
+###############################################################################
 """
 
 import datetime
@@ -22,15 +22,14 @@
 import ssl
 import sys
 
-# import numpy
 import openmeteo_requests
 import paho.mqtt.client as mqtt
 import pytz
 import requests_cache  # seeAlso: https://pypi.org/project/requests-cache/
 from lib.weather_codes import translate_weather_code
 from retry_requests import retry  # seeAlso: https://pypi.org/project/retry-requests/
 
-__version__ = "1.0.2"
+__version__ = "1.1.0"
 __script_path__ = os.path.dirname(__file__)
 __config_path__ = os.path.join(os.path.dirname(__script_path__), "etc")
 __local_tz__ = pytz.timezone("UTC")
@@ -72,12 +71,13 @@ def __makeAbsolutePath(path: str) -> str:
 
 def initialize_logger(severity: int = logging.INFO) -> logging.Logger:
     """
-    Initialize the logger with the given severity level.\n
-    :param severity int: The optional severity level for the logger. (default: 20 (INFO))\n
-    :return logging.RootLogger: The initialized logger.\n
-    :raise ValueError: If the severity level is not valid.\n
-    :raise TypeError: If the severity level is not an integer.\n
-    :raise Exception: If the logger cannot be initialized.\n
+    Initialize the logger with the given severity level.
+
+    :param severity int: The optional severity level for the logger. (default: 20 (INFO))
+    :return logging.RootLogger: The initialized logger.
+    :raise ValueError: If the severity level is not valid.
+    :raise TypeError: If the severity level is not an integer.
+    :raise Exception: If the logger cannot be initialized.
     """
     valid_severity = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL]
     if severity not in valid_severity:
@@ -97,11 +97,12 @@ def initialize_logger(severity: int = logging.INFO) -> logging.Logger:
 
 def load_config_file() -> dict:
     """
-    Load the configuration file and return the configuration as a dictionary.\n
-    :return dict: The loaded configuration.\n
-    :raise ValueError: If the configuration file is not valid.\n
-    :raise TypeError: If the configuration file is not a string.\n
-    :raise Exception: If the configuration file cannot be loaded.\n
+    Load the configuration file and return the configuration as a dictionary.
+
+    :return dict: The loaded configuration.
+    :raise ValueError: If the configuration file is not valid.
+    :raise TypeError: If the configuration file is not a string.
+    :raise Exception: If the configuration file cannot be loaded.
     """
     if os.environ.get("MODE") is not None:
         config_file = os.path.join(__config_path__, os.environ.get("MODE") + ".json")
@@ -134,9 +135,11 @@ def load_config_file() -> dict:
 
 def initialize_mqtt_client() -> mqtt.Client:
     """
-    Initialize the MQTT client with the given configuration from environment.\n
-    :return mqtt.Client: The initialized MQTT client.\n
-    :raise Exception: If the MQTT client cannot be initialized.\n
+    Initialize the MQTT client with the given configuration from environment.
+
+    :return mqtt.Client: The initialized MQTT client.
+    :raise ValueError: If the MQTT client configuration is not valid.
+    :raise Exception: If the MQTT client cannot be initialized.
     """
     if os.environ.get("MQTT_CLIENT_ID") is not None:
         log.debug("Use MQTT client ID: {}".format(os.environ.get("MQTT_CLIENT_ID")))
@@ -185,19 +188,28 @@ def initialize_mqtt_client() -> mqtt.Client:
             client.tls_insecure_set(False)
 
     # configure authentication
-    if os.environ.get("MQTT_USERNAME") is not None and os.environ.get("MQTT_PASSWORD") is not None:
+    mqtt_pass = None
+    if os.environ.get("MQTT_PASSWORD") is not None:
+        mqtt_pass = os.environ.get("MQTT_PASSWORD")
+    if os.environ.get("MQTT_PASSWORD_FILE") is not None:
+        if not os.path.isfile(os.environ.get("MQTT_PASSWORD_FILE")):
+            raise ValueError("MQTT password file {} not found.".format(os.environ.get("MQTT_PASSWORD_FILE")))
+        with open(os.environ.get("MQTT_PASSWORD_FILE"), "r") as f:
+            mqtt_pass = f.read().strip()
+    if os.environ.get("MQTT_USERNAME") is not None and mqtt_pass is not None:
         log.debug("Set username ({}) and password for MQTT connection".format(os.environ.get("MQTT_USERNAME")))
-        client.username_pw_set(os.environ.get("MQTT_USERNAME"), os.environ.get("MQTT_PASSWORD"))
+        client.username_pw_set(os.environ.get("MQTT_USERNAME"), mqtt_pass)
 
     return client
 
 
 def request_weather_data(payload: dict) -> dict:
     """
-    Request weather data from the Open-Meteo API with the given configuration.\n
-    :param payload dict: The configuration for the Open-Meteo API request.\n
-    :return dict: The weather data from the Open-Meteo API.\n
-    :raise Exception: If the weather data cannot be requested.\n
+    Request weather data from the Open-Meteo API with the given configuration.
+
+    :param payload dict: The configuration for the Open-Meteo API request.
+    :return dict: The weather data from the Open-Meteo API.
+    :raise Exception: If the weather data cannot be requested.
     """
     log.debug(f"Request Open-Meteo API {__open_meteo_api_url__} with parameters: {payload}")
     # initialize cache directory
@@ -240,11 +252,12 @@ def request_weather_data(payload: dict) -> dict:
 
 def parse_current_weather(data: any, fields: list = []) -> dict:
     """
-    Parse the current weather data from the Open-Meteo API response.\n
-    :param data openmeteo_requests.VariablesWithTime: The Open-Meteo API response from current weather.\n
-    :param fields list: The list of fields to parse from the current weather data. (default: [])\n
-    :return dict: The parsed current weather data.\n
-    :raise Exception: If the current weather data cannot be parsed.\n
+    Parse the current weather data from the Open-Meteo API response.
+
+    :param data openmeteo_requests.VariablesWithTime: The Open-Meteo API response from current weather.
+    :param fields list: The list of fields to parse from the current weather data. (default: [])
+    :return dict: The parsed current weather data.
+    :raise Exception: If the current weather data cannot be parsed.
     """
     if not data:
         raise Exception("No current weather data found in the response.")
@@ -269,11 +282,12 @@ def parse_current_weather(data: any, fields: list = []) -> dict:
 
 def parse_daily_weather(data: any, fields: list = []) -> dict:
     """
-    Parse the daily weather data from the Open-Meteo API response.\n
-    :param data openmeteo_requests.VariablesWithTime: The Open-Meteo API response from current weather.\n
-    :param fields list: The list of fields to parse from the current weather data. (default: [])\n
-    :return dict: The parsed current weather data.\n
-    :raise Exception: If the current weather data cannot be parsed.\n
+    Parse the daily weather data from the Open-Meteo API response.
+
+    :param data openmeteo_requests.VariablesWithTime: The Open-Meteo API response from current weather.
+    :param fields list: The list of fields to parse from the current weather data. (default: [])
+    :return dict: The parsed current weather data.
+    :raise Exception: If the current weather data cannot be parsed.
     """
     if not data:
         raise Exception("No current weather data found in the response.")
@@ -352,24 +366,6 @@ def parse_daily_weather(data: any, fields: list = []) -> dict:
     # Add the local time as message_timestamp to payload
     weather_result["message_timestamp"] = __local_tz__.localize(datetime.datetime.now()).isoformat()
 
-    """
-    PAYLOAD = {
-        "message_timestamp": __local_tz__.localize(datetime.datetime.now()).isoformat(),
-        "weather": {
-            "temperature": 20,
-            "humidity": 50,
-            "wind_speed": 5,
-            "precipitation": 0,
-            "weather_code": 0,
-            "weather_code_text": translate_weather_code(0),
-        },
-        "location": {
-            "latitude": float(os.environ.get("LATITUDE")),
-            "longitude": float(os.environ.get("LONGITUDE")),
-            "elevation": 409.0,
-        },
-    }
-    """
     log.debug("Payload: {}".format(json.dumps(weather_result)))
 
     # initialize MQTT client and connect to broker

src/requirements.txt

@@ -1,5 +1,4 @@
 openmeteo_requests>=1.3.0,<2
-#pandas>=2.2.3,<3
 paho-mqtt>=2.1.0
 pytz>=2024.2
 requests>=2.32.3

test/__init__.py

@@ -16,3 +16,4 @@
 os.environ["ELEVATION"] = "3.0"
 os.environ["WEATHER_MODELS"] = "FooBar"
 os.environ["TZ"] = "UTC"
+os.environ["MQTT_CLIENT_ID"] = ""

test/requirements.txt

@@ -0,0 +1,2 @@
+pytest>=9.0.0
+ruff>=0.14.0