Add readme

Author: iliamous

README.md

@@ -1,3 +1,37 @@
-# Dashboard-DSS Integration Example
+# Dashboard Mediator
 
-To-Do.
+A FastAPI-based service that orchestrates Eclipse Dataspace Connector (EDC) contract negotiations and data transfers. The Mediator acts as an intermediary that manages the complex workflow of negotiating data access contracts and coordinating secure data transfers between connectors.
+
+## Overview
+
+The Dashboard Mediator simplifies EDC interactions by:
+
+-   **Automating contract negotiation** with provider connectors
+-   **Managing transfer processes** using pull-based data access
+-   **Receiving credentials** via Server-Sent Events (SSE) for secure data retrieval
+-   **Providing a simple REST API** for initiating EDC workflows
+
+## Architecture
+
+```
+┌─────────────┐      ┌──────────────────┐      ┌──────────────┐
+│   Client    │─────▶│     Mediator     │─────▶│   Provider   │
+│ Application │      │   (This Service) │      │  Connector   │
+└─────────────┘      └──────────────────┘      └──────────────┘
+                              │
+                              │ SSE
+                              ▼
+                     ┌──────────────────┐
+                     │ Consumer Backend │
+                     │  (Credentials)   │
+                     └──────────────────┘
+```
+
+## Features
+
+-   **Contract Negotiation**: Automated negotiation flow with provider connectors
+-   **Transfer Management**: Handles transfer process initiation and monitoring
+-   **SSE-based Credentials**: Real-time credential reception via Server-Sent Events
+-   **Bearer Token Extraction**: Automatic extraction of access tokens for data retrieval
+-   **Comprehensive Logging**: Detailed logging with colored output for debugging
+-   **Input Validation**: Pydantic-based validation for all API inputs

logger_config.py

@@ -14,7 +14,7 @@ def setup_logging(level: str = "DEBUG") -> logging.Logger:
     """
 
     coloredlogs.install(level=level)
-    logger = logging.getLogger("orchestrator")
+    logger = logging.getLogger("mediator")
 
     logging.getLogger("httpcore").setLevel(logging.INFO)
     logging.getLogger("httpx").setLevel(logging.INFO)

main.py

@@ -3,8 +3,8 @@
 
 
 app = FastAPI(
-    title="Dashboard Backend API",
-    description="Dashboard backend that orchestrates connector negotiation and transfer via connectors",
+    title="Dashboard Mediator API",
+    description="Dashboard Mediator that orchestrates connector negotiation and transfer via connectors",
     version="1.0.0",
 )
 
@@ -17,5 +17,5 @@ async def health_check():
     """Health check endpoint"""
     return {
         "status": "healthy",
-        "service": "Dashboard Orchestrator"
+        "service": "Dashboard Mediator"
     }

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "orchestrator"
+name = "mediator"
 version = "0.1.0"
-description = "The Orchestrator is responsible for managing contract negotiation and coordinating communication between the various servers involved in the process."
+description = "The Mediator is responsible for managing contract negotiation and coordinating communication between the various servers involved in the process."
 authors = [
     {name = "Ilias Moysidis",email = "iliamous@iti.gr"}
 ]