Merge pull request #24 from NHSDigital/feat/add-dotenv

Load environment on each service entrypoint

Author: steventux

README.md

@@ -82,6 +82,24 @@ make test-lint
 make test-unit ARGS="-v"
 ```
 
+### Running locally with Docker
+
+```bash
+docker compose up --build
+```
+
+### Running an individual service locally
+
+```bash
+cp .env.development .env
+```
+
+Edit `.env` to set the required environment variables for the service you want to run, e.g. `PACS_DB_PATH` for the PACS server.
+
+```bash
+PYTHONPATH=./src uv run python -m pacs_main
+```
+
 ### Code Quality
 
 Pre-commit hooks run automatically on commit:

pyproject.toml

@@ -14,6 +14,7 @@ dependencies = [
   "pillow>=11.0.0",
   "websockets==15.0.1",
   "requests>=2.32.0",
+  "python-dotenv>=1.2.1",
 ]
 
 [dependency-groups]

src/mwl_main.py

@@ -3,11 +3,22 @@
 import logging
 import os
 
+from dotenv import load_dotenv
+
 from server import MWLServer
 
+load_dotenv()
+
 
 def main():
-    """Main entry point for MWL server."""
+    """
+    Main entry point for MWL server.
+
+    Environment variables:
+    MWL_AET: AE Title for the MWL server (default: MWL_SCP)
+    MWL_PORT: Port to listen on (default: 4243)
+    MWL_DB_PATH: Path to the SQLite database file (default: /var/lib/pacs/worklist.db)
+    """
     logging.basicConfig(
         level=os.getenv("LOG_LEVEL", "INFO").upper(),
         format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),

src/pacs_main.py

@@ -3,11 +3,23 @@
 import logging
 import os
 
+from dotenv import load_dotenv
+
 from server import PACSServer
 
+load_dotenv()
+
 
 def main():
-    """Main entry point for PACS server."""
+    """
+    Main entry point for PACS server.
+
+    Environment variables:
+    PACS_AET: AE Title for the PACS server (default: SCREENING_PACS)
+    PACS_PORT: Port to listen on (default: 4244)
+    PACS_STORAGE_PATH: Path to store incoming DICOM files (default: /var/lib/pacs/storage)
+    PACS_DB_PATH: Path to the SQLite database file (default: /var/lib/pacs/pacs.db)
+    """
     logging.basicConfig(
         level=os.getenv("LOG_LEVEL", "INFO").upper(),
         format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),

src/relay_listener.py

@@ -14,11 +14,14 @@
 import time
 import urllib.parse
 
+from dotenv import load_dotenv
 from websockets.asyncio.client import connect
 
 from services.mwl.create_worklist_item import CreateWorklistItem
 from services.storage import MWLStorage
 
+load_dotenv()
+
 logger = logging.getLogger(__name__)
 
 DB_PATH = os.getenv("MWL_DB_PATH", "/var/lib/pacs/worklist.db")
@@ -30,7 +33,17 @@
 
 
 class RelayListener:
-    """Socket Listener for Azure Relay."""
+    """
+    Socket Listener for Azure Relay.
+
+    Listens for incoming messages from Azure Relay and processes worklist actions.
+    Environment variables:
+    AZURE_RELAY_NAMESPACE: Azure Relay namespace (default: relay-test.servicebus.windows.net)
+    AZURE_RELAY_HYBRID_CONNECTION: Azure Relay hybrid connection name (default: relay-test-hc)
+    AZURE_RELAY_KEY_NAME: Azure Relay shared access key name (default: RootManageSharedAccessKey)
+    AZURE_RELAY_SHARED_ACCESS_KEY: Azure Relay shared access key (default: none)
+    MWL_DB_PATH: Path to the MWL SQLite database file (default: /var/lib/pacs/worklist.db)
+    """
 
     def __init__(self, storage: MWLStorage):
         self.storage = storage

src/upload_main.py

@@ -3,14 +3,30 @@
 import logging
 import os
 
+from dotenv import load_dotenv
+
 from services.dicom.dicom_uploader import DICOMUploader
 from services.dicom.upload_listener import UploadListener
 from services.dicom.upload_processor import UploadProcessor
 from services.storage import MWLStorage, PACSStorage
 
+load_dotenv()
+
 
 def main():
-    """Main entry point for upload listener service."""
+    """
+    Main entry point for upload listener service.
+
+    Environment variables:
+    CLOUD_API_ENDPOINT: URL of the cloud API endpoint to upload to (default: http://localhost:8000/api/dicom/upload)
+    CLOUD_API_KEY: API key for authenticating with the cloud API (default: none)
+    MAX_UPLOAD_RETRIES: Maximum number of upload retries before giving up (default: 3)
+    MWL_DB_PATH: Path to the MWL SQLite database file (default: /var/lib/pacs/worklist.db)
+    PACS_DB_PATH: Path to the PACS SQLite database file (default: /var/lib/pacs/pacs.db)
+    PACS_STORAGE_PATH: Path to the directory where DICOM files are stored (default: /var/lib/pacs/storage)
+    UPLOAD_POLL_INTERVAL: Time in seconds between polling for new uploads (default: 2)
+    UPLOAD_BATCH_SIZE: Number of pending uploads to process in each batch (default: 10)
+    """
     logging.basicConfig(
         level=os.getenv("LOG_LEVEL", "INFO").upper(),
         format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),
@@ -20,8 +36,10 @@ def main():
     batch_size = int(os.getenv("UPLOAD_BATCH_SIZE", "10"))
     max_retries = int(os.getenv("MAX_UPLOAD_RETRIES", "3"))
 
-    pacs_storage = PACSStorage()
-    mwl_storage = MWLStorage()
+    pacs_storage = PACSStorage(
+        os.getenv("PACS_DB_PATH", "/var/lib/pacs/pacs.db"), os.getenv("PACS_STORAGE_PATH", "/var/lib/pacs/storage")
+    )
+    mwl_storage = MWLStorage(os.getenv("MWL_DB_PATH", "/var/lib/pacs/worklist.db"))
     uploader = DICOMUploader()
 
     processor = UploadProcessor(