add docstrings

add documentation tags

add some error handling

src/vmr_http/app.py

@@ -1,19 +1,42 @@
+"""entry point for the FastAPI application."""
+
 from contextlib import asynccontextmanager
 
 import voicemeeterlib
-from fastapi import FastAPI
+from fastapi import Depends, FastAPI, HTTPException
+from voicemeeterlib.error import CAPIError
 
+from .dependencies import get_voicemeeter_client
 from .web import bus, strip
 
 
 @asynccontextmanager
 async def lifespan(app):
-    app.state.voicemeeter = voicemeeterlib.connect("potato", sync=True)
+    """Lifespan function to initialize and clean up the Voicemeeter client."""
+    app.state.voicemeeter = voicemeeterlib.api('potato', sync=True)
     app.state.voicemeeter.login()
     yield
     app.state.voicemeeter.logout()
 
 
-app = FastAPI(lifespan=lifespan)
-app.include_router(strip.router, prefix="/strip")
-app.include_router(bus.router, prefix="/bus")
+app = FastAPI(
+    lifespan=lifespan,
+    description='A REST API for controlling Voicemeeter.',
+    openapi_tags=[
+        {'name': 'strip', 'description': 'Endpoints for controlling strip parameters.'},
+        {'name': 'bus', 'description': 'Endpoints for controlling bus parameters.'},
+    ],
+)
+app.include_router(strip.router, prefix='/strip')
+app.include_router(bus.router, prefix='/bus')
+
+
+@app.get('/health')
+def health_check(voicemeeter=Depends(get_voicemeeter_client)):
+    """Health check endpoint to verify the service is running."""
+    try:
+        version = voicemeeter.version  # Check if we can communicate with Voicemeeter
+        type_ = voicemeeter.type
+    except CAPIError as e:
+        raise HTTPException(status_code=503, detail=f'Voicemeeter API error: {str(e)}')
+    return {'status': 'ok', 'service': 'vmr-http', 'version': version, 'type': type_}