mesh-sandbox 1.0.10__py3-none-any.whl → 1.0.12__py3-none-any.whl

mesh_sandbox/tests/mesh_client_tests.py

@@ -41,36 +41,32 @@ def _mesh_client_track_message_by_message_id(base_uri: str, sender_mailbox_id: s
     with MeshClient(
         url=base_uri, mailbox=sender_mailbox_id, password=_PASSWORD, shared_key=_SHARED_KEY, max_chunk_size=100
     ) as sender:
-        tracking = sender.track_by_message_id(message_id)
+        tracking = sender.track_message(message_id)
         assert tracking
         return tracking
 
 
 def test_app_health(base_uri: str):
-
     with httpx.Client(base_url=base_uri) as client:
         res = client.get("/health")
         assert res.status_code == status.HTTP_200_OK
 
 
 def test_handshake(base_uri: str):
-
     with MeshClient(url=base_uri, mailbox=_CANNED_MAILBOX1, password=_PASSWORD, shared_key=_SHARED_KEY) as client:
         res = client.handshake()
         assert res == b"hello"
 
 
 def test_handshake_bad_password(base_uri: str):
-
     with MeshClient(url=base_uri, mailbox=_CANNED_MAILBOX1, password="BAD", shared_key=_SHARED_KEY) as client:
-
         with pytest.raises(HTTPError) as err:
             client.handshake()
+        assert err.value.response is not None
         assert err.value.response.status_code == status.HTTP_403_FORBIDDEN
 
 
 def test_send_receive_chunked_message(base_uri: str):
-
     workflow_id = uuid4().hex
     sent_payload = b"a" * 1000
     message_id = _mesh_client_send_message(base_uri, _CANNED_MAILBOX1, _CANNED_MAILBOX2, workflow_id, sent_payload)
@@ -90,16 +86,15 @@ def test_send_receive_chunked_message(base_uri: str):
 
 
 def test_track_message_by_message_id(base_uri: str):
-
     workflow_id = uuid4().hex
     sent_payload = b"a" * 1000
     message_id = _mesh_client_send_message(base_uri, _CANNED_MAILBOX1, _CANNED_MAILBOX2, workflow_id, sent_payload)
     assert _mesh_client_get_inbox_count(base_uri, _CANNED_MAILBOX2) == 1
 
     tracking = _mesh_client_track_message_by_message_id(base_uri, _CANNED_MAILBOX1, message_id)
-    assert tracking["messageId"] == message_id
-    assert tracking["status"] == "Accepted"
-    assert tracking["sender"] == _CANNED_MAILBOX1
+    assert tracking["message_id"] == message_id
+    assert tracking["status"] == "accepted"
+    # assert tracking["sender"] == _CANNED_MAILBOX1
     assert tracking["recipient"] == _CANNED_MAILBOX2
 
     with MeshClient(url=base_uri, mailbox=_CANNED_MAILBOX2, password=_PASSWORD, shared_key=_SHARED_KEY) as recipient:
@@ -107,5 +102,5 @@ def test_track_message_by_message_id(base_uri: str):
         message.acknowledge()
 
     tracking = _mesh_client_track_message_by_message_id(base_uri, _CANNED_MAILBOX1, message_id)
-    assert tracking["messageId"] == message_id
-    assert tracking["status"] == "Acknowledged"
+    assert tracking["message_id"] == message_id
+    assert tracking["status"] == "acknowledged"

mesh_sandbox/tests/messaging_tests.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional
+from typing import Any, ClassVar, Optional
 from uuid import uuid4
 
 import pytest
@@ -17,8 +17,8 @@ from ..models.message import (
 from .helpers import temp_env_vars
 
 
-@pytest.fixture(name="message", scope="function")
-def _create_message() -> Message:
+@pytest.fixture(name="message")
+def create_message() -> Message:
     message = Message(
         message_id=uuid4().hex.upper(),
         workflow_id=uuid4().hex.upper(),
@@ -30,26 +30,24 @@ def _create_message() -> Message:
     return message
 
 
-@pytest.fixture(name="background_tasks", scope="function")
-def _background_tasks() -> BackgroundTasks:
+@pytest.fixture(name="background_tasks")
+def background_tasks() -> BackgroundTasks:
     return BackgroundTasks()
 
 
 async def test_canned_store_raises_for_save_message(message: Message):
+    with temp_env_vars(STORE_MODE="canned"):
+        store = get_store()
 
-    with pytest.raises(NotImplementedError):
-        with temp_env_vars(STORE_MODE="canned"):
-            store = get_store()
+        with pytest.raises(NotImplementedError):
             await store.save_message(message)
 
 
 async def test_canned_messaging_does_not_raise_no_bgt(message: Message):
-
     calls = []
 
     class TestPlugin:
-
-        triggers = ["before_save_message", "after_save_message", "save_message_error"]
+        triggers: ClassVar[list[str]] = ["before_save_message", "after_save_message", "save_message_error"]
 
         async def on_event(self, event: str, args: dict[str, Any], exception: Optional[Exception] = None):
             calls.append((event, args, exception))
@@ -64,12 +62,10 @@ async def test_canned_messaging_does_not_raise_no_bgt(message: Message):
 
 
 async def test_canned_messaging_does_not_raise_with_bgt(message: Message, background_tasks: BackgroundTasks):
-
     calls = []
 
     class Test2Plugin:
-
-        triggers = ["before_save_message", "after_save_message", "save_message_error"]
+        triggers: ClassVar[list[str]] = ["before_save_message", "after_save_message", "save_message_error"]
 
         async def on_event(self, event: str, args: dict[str, Any], exception: Optional[Exception] = None):
             calls.append((event, args, exception))
@@ -87,12 +83,10 @@ async def test_canned_messaging_does_not_raise_with_bgt(message: Message, backgr
 
 
 async def test_messaging_does_not_raise_with_bgt(message: Message, background_tasks: BackgroundTasks):
-
     calls = []
 
     class Test2Plugin:
-
-        triggers = ["before_save_message", "after_save_message", "save_message_error"]
+        triggers: ClassVar[list[str]] = ["before_save_message", "after_save_message", "save_message_error"]
 
         async def on_event(self, event: str, args: dict[str, Any], exception: Optional[Exception] = None):
             calls.append((event, args, exception))
@@ -110,12 +104,10 @@ async def test_messaging_does_not_raise_with_bgt(message: Message, background_ta
 
 
 async def test_error_events_raised_with_bgt(message: Message, background_tasks: BackgroundTasks):
-
     calls = []
 
     class Test2Plugin:
-
-        triggers = ["before_save_message", "after_save_message", "save_message_error"]
+        triggers: ClassVar[list[str]] = ["before_save_message", "after_save_message", "save_message_error"]
 
         async def on_event(self, event: str, args: dict[str, Any], exception: Optional[Exception] = None):
             calls.append((event, args, exception))
@@ -133,15 +125,13 @@ async def test_error_events_raised_with_bgt(message: Message, background_tasks:
 
 
 class TestDiscoveredPlugin:
-
-    triggers = ["before_accept_message"]
+    triggers: ClassVar[list[str]] = ["before_accept_message"]
 
     async def on_event(self, event: str, args: dict[str, Any], err: Optional[Exception] = None):
         pass
 
 
 async def test_plugin_discovery(monkeypatch):
-
     messaging = Messaging(store=get_store(), plugins_module=tests_module)
 
     calls = []

mesh_sandbox/tests/outbox.py

@@ -18,7 +18,6 @@ _CANNED_MAILBOX2 = "X26ABC2"
 
 @pytest.mark.parametrize("accept", [APP_V1_JSON, APP_V2_JSON])
 def test_memory_send_message_with_local_id(app: TestClient, accept: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -130,12 +129,10 @@ def test_memory_send_message_with_local_id(app: TestClient, accept: str):
 
 @pytest.mark.parametrize("accept", [APP_V1_JSON, APP_V2_JSON])
 def test_file_send_message_with_local_id(app: TestClient, accept: str, tmp_path: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
     with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
-
         res = app.get(
             f"/messageexchange/{recipient}/inbox",
             headers={Headers.Authorization: generate_auth_token(recipient), Headers.Accept: accept},
@@ -193,7 +190,6 @@ def test_file_send_message_with_local_id(app: TestClient, accept: str, tmp_path:
 
 @pytest.mark.parametrize("accept", [APP_V1_JSON, APP_V2_JSON])
 def test_memory_send_chunked_message(app: TestClient, accept: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -313,12 +309,10 @@ def test_memory_send_chunked_message(app: TestClient, accept: str):
 
 @pytest.mark.parametrize("accept", [APP_V1_JSON, APP_V2_JSON])
 def test_file_send_chunked_message(app: TestClient, accept: str, tmp_path: str):  # pylint: disable=too-many-statements
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
     with temp_env_vars(STORE_MODE="file", MAILBOXES_DATA_DIR=tmp_path):
-
         res = app.get(
             f"/messageexchange/{recipient}/inbox",
             headers={Headers.Authorization: generate_auth_token(recipient), Headers.Accept: accept},
@@ -462,7 +456,6 @@ def test_file_send_chunked_message(app: TestClient, accept: str, tmp_path: str):
     ],
 )
 def test_mex_content_compress_validation(app: TestClient, value: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -500,7 +493,6 @@ def test_mex_content_compress_validation(app: TestClient, value: str):
     ],
 )
 def test_mex_content_encrypted_validation(app: TestClient, value: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -538,7 +530,6 @@ def test_mex_content_encrypted_validation(app: TestClient, value: str):
     ],
 )
 def test_mex_content_compressed_validation(app: TestClient, value: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -547,7 +538,7 @@ def test_mex_content_compressed_validation(app: TestClient, value: str):
 
 
 @pytest.mark.parametrize(
-    "mex_content_checksum, expected_response_status",
+    ("mex_content_checksum", "expected_response_status"),
     [
         ("", status.HTTP_202_ACCEPTED),
         ("b10a8db164e0754105b7a99be72e3fe5", status.HTTP_202_ACCEPTED),
@@ -559,7 +550,6 @@ def test_mex_content_compressed_validation(app: TestClient, value: str):
     ],
 )
 def test_mex_content_checksum_validation(app: TestClient, mex_content_checksum: str, expected_response_status: int):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -571,7 +561,6 @@ def test_mex_content_checksum_validation(app: TestClient, mex_content_checksum:
 
 
 def test_mex_local_id_validation(app: TestClient):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
 
@@ -584,7 +573,6 @@ def test_mex_local_id_validation(app: TestClient):
 
 @pytest.mark.parametrize("accept", [APP_V1_JSON, APP_V2_JSON])
 def test_checksum_is_returned(app: TestClient, accept: str):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
     checksum = uuid4().hex
@@ -614,7 +602,6 @@ def test_checksum_is_returned(app: TestClient, accept: str):
 
 
 def test_rich_outbox_returns_most_recent_messages(app: TestClient):
-
     sender = _CANNED_MAILBOX1
     recipient = _CANNED_MAILBOX2
     total_messages = 105
@@ -627,7 +614,6 @@ def test_rich_outbox_returns_most_recent_messages(app: TestClient):
 
     message_ids = {}
     for index in range(total_messages):
-
         resp = mesh_api_send_message(
             app,
             sender_mailbox_id=sender,

mesh_sandbox/tests/serialisation.py

@@ -6,7 +6,6 @@ from ..store.serialisation import deserialise_model, serialise_model
 
 
 def test_serialise_deserialise_message():
-
     message = Message(
         message_id=uuid4().hex,
         metadata=MessageMetadata(local_id=uuid4().hex),

mesh_sandbox/views/error.py

@@ -12,7 +12,6 @@ from ..dependencies import parse_accept_header
 
 
 class MeshErrorV1(BaseModel):
-
     messageID: Optional[str] = Field(description="message_id associated with the error", default=None)
     errorEvent: Optional[str] = Field(description="message error phase", default="")
     errorCode: Optional[str] = Field(description="message error code", default="")
@@ -20,7 +19,7 @@ class MeshErrorV1(BaseModel):
 
     class Config:
         title = "mesh_error_v1"
-        schema_extra = {
+        json_schema_extra = {
             "example": {
                 "messageID": "20220228174323222_ABCDEF",
                 "errorEvent": "SEND",
@@ -31,14 +30,13 @@ class MeshErrorV1(BaseModel):
 
 
 class MeshErrorV2(BaseModel):
-
     message_id: Optional[str] = Field(description="message id associated with the error", default=None)
     internal_id: Optional[str] = Field(description="internal id associated with the error", default=None)
     detail: list[dict] = Field(description="error detail", default_factory=list)
 
     class Config:
         title = "mesh_error_v2"
-        schema_extra = {
+        json_schema_extra = {
             "example": {
                 "message_id": "20220228174323222_ABCDEF",
                 "internal_id": "20220228174323222_ABCDEF",
@@ -48,7 +46,6 @@ class MeshErrorV2(BaseModel):
 
 
 def get_validation_error_response(_request: Request, exc: RequestValidationError) -> Response:
-
     for err in exc.errors():
         if err["loc"][0] == "header" and cast(str, err["loc"][1]).lower() == Headers.Authorization.lower():
             return Response(status_code=status.HTTP_403_FORBIDDEN)
@@ -67,9 +64,8 @@ def get_error_response(
     status_code: int,
     detail: Union[str, dict, None] = None,
     message_id: Optional[str] = None,
-    headers: dict = None,  # type: ignore[assignment]
+    headers: Optional[dict] = None,  # type: ignore[assignment]
 ) -> JSONResponse:
-
     internal_id = None
     if hasattr(request.state, "internal_id"):
         internal_id = request.state.internal_id

mesh_sandbox/views/inbox.py

@@ -10,16 +10,14 @@ from . import RichMessageV1
 
 
 class InboxV1(BaseModel):
-
     messages: list[str] = Field(description="list of message ids in the inbox, up to 'max_results'")
 
     class Config:
         title = "inbox_v1"
-        schema_extra = {"example": {"messages": ["20220228174323222_ABCDEF", "20220228174323333_ABCDEF"]}}
+        json_schema_extra = {"example": {"messages": ["20220228174323222_ABCDEF", "20220228174323333_ABCDEF"]}}
 
 
 class InboxV2(BaseModel):
-
     messages: list[str] = Field(description="list of message ids in the inbox, up to 'max_results'")
     links: Optional[dict[str, str]] = Field(description="map of links, e.g. links.next if more results exist")
     approx_inbox_count: Optional[int] = Field(
@@ -31,7 +29,7 @@ class InboxV2(BaseModel):
 
     class Config:
         title = "inbox_v2"
-        schema_extra = {
+        json_schema_extra = {
             "example": {
                 "messages": ["20220228174323222_ABCDEF", "20220228174323333_ABCDEF"],
                 "links": {
@@ -45,12 +43,11 @@ class InboxV2(BaseModel):
 
 
 class AcknowledgeV1(BaseModel):
-
     messageId: str = Field(description="message_id as passed in on the url")
 
     class Config:
         title = "acknowledge_message"
-        schema_extra = {"example": {"messageId": ["20220228174323222_ABCDEF"]}}
+        json_schema_extra = {"example": {"messageId": ["20220228174323222_ABCDEF"]}}
 
 
 class InboxMessageV1(RichMessageV1):
@@ -94,7 +91,7 @@ class RichInboxView(BaseModel):
 
     class Config:
         title = "rich_inbox"
-        schema_extra = {
+        json_schema_extra = {
             "example": {
                 "valid_at": "2021-11-22T14:35:52.29Z",
                 "messages": [

mesh_sandbox/views/lookup.py

@@ -13,7 +13,7 @@ class EndpointLookupItemV1(BaseModel):
 
     class Config:
         title = "endpoint_lookup_item_v1"
-        schema_extra = {
+        json_schema_extra = {
             "example": {"address": "X2612345", "description": "this is a test mailbox", "endpoint_type": "MESH"}
         }
 
@@ -24,7 +24,7 @@ class EndpointLookupV1(BaseModel):
 
     class Config:
         title = "endpoint_lookup_v1"
-        schema_extra = {
+        json_schema_extra = {
             "example": {
                 "query_id": "20220228174323222_ABCDEF",
                 "results": {"address": "X2612345", "description": "this is a test mailbox", "endpoint_type": "MESH"},
@@ -38,7 +38,7 @@ class MailboxLookupItem(BaseModel):
 
     class Config:
         title = "lookup_item_v2"
-        schema_extra = {"example": {"mailbox_id": "X2612345", "mailbox_name": "this is a test mailbox"}}
+        json_schema_extra = {"example": {"mailbox_id": "X2612345", "mailbox_name": "this is a test mailbox"}}
 
 
 class MailboxLookupV2(BaseModel):
@@ -46,13 +46,14 @@ class MailboxLookupV2(BaseModel):
 
     class Config:
         title = "lookup_v2"
-        schema_extra = {"example": {"results": {"mailbox_id": "X2612345", "mailbox_name": "this is a test mailbox"}}}
+        json_schema_extra = {
+            "example": {"results": {"mailbox_id": "X2612345", "mailbox_name": "this is a test mailbox"}}
+        }
 
 
 def endpoint_lookup_response(
     mailboxes: list[Mailbox], model_version: int = 1
 ) -> Union[EndpointLookupV1, MailboxLookupV2]:
-
     if model_version < 2:
         return EndpointLookupV1(
             query_id=uuid4().hex,
@@ -75,7 +76,6 @@ def endpoint_lookup_response(
 
 # pylint: disable=unused-argument
 def workflow_search_response(mailboxes: list[Mailbox], model_version: int = 1) -> MailboxLookupV2:
-
     return MailboxLookupV2(
         results=[
             MailboxLookupItem(

mesh_sandbox/views/outbox.py

@@ -14,7 +14,7 @@ class SendMessageV1(BaseModel):
 
     class Config:
         title = "send_message"
-        schema_extra = {"example": {"messageID": "20220228174323222_ABCDEF"}}
+        json_schema_extra = {"example": {"messageID": "20220228174323222_ABCDEF"}}
 
 
 class SendMessageV2(BaseModel):
@@ -22,7 +22,7 @@ class SendMessageV2(BaseModel):
 
     class Config:
         title = "send_message"
-        schema_extra = {"example": {"message_id": "20220228174323222_ABCDEF"}}
+        json_schema_extra = {"example": {"message_id": "20220228174323222_ABCDEF"}}
 
 
 class UploadChunkV1(BaseModel):
@@ -31,11 +31,10 @@ class UploadChunkV1(BaseModel):
 
     class Config:
         title = "upload_chunk"
-        schema_extra = {"example": {"messageID": "20220228174323222_ABCDEF", "blockID": 3}}
+        json_schema_extra = {"example": {"messageID": "20220228174323222_ABCDEF", "blockID": 3}}
 
 
 class OutboxMessageV1(RichMessageV1):
-
     # pylint: disable=E0213
     class Config:
         validate_assignment = True
@@ -53,7 +52,7 @@ class RichOutboxView(BaseModel):
     class Config:
         validate_assignment = True
         title = "rich_outbox"
-        schema_extra = {
+        json_schema_extra = {
             "example": {
                 "valid_at": "2021-11-22T14:35:52.29Z",
                 "messages": [
@@ -85,26 +84,24 @@ class RichOutboxView(BaseModel):
 
 
 def map_to_outbox_message(messages: list[Message]) -> list[OutboxMessageV1]:
-    return list(
-        map(
-            lambda msg: OutboxMessageV1(
-                message_id=msg.message_id,
-                expiry_timestamp=msg.inbox_expiry_timestamp,
-                local_id=msg.metadata.local_id,
-                message_type=msg.message_type,
-                recipient=msg.recipient.mailbox_id,
-                recipient_name=msg.recipient.mailbox_name,
-                sender=msg.sender.mailbox_id,
-                sender_name=msg.sender.mailbox_name,
-                sent_date=msg.created_timestamp,
-                status=msg.status,
-                status_code=msg.last_event.code,
-                workflow_id=msg.workflow_id,
-                total_chunks=msg.total_chunks or 0,
-            ),
-            messages,
+    return [
+        OutboxMessageV1(
+            message_id=msg.message_id,
+            expiry_timestamp=msg.inbox_expiry_timestamp,
+            local_id=msg.metadata.local_id,
+            message_type=msg.message_type,
+            recipient=msg.recipient.mailbox_id,
+            recipient_name=msg.recipient.mailbox_name,
+            sender=msg.sender.mailbox_id,
+            sender_name=msg.sender.mailbox_name,
+            sent_date=msg.created_timestamp,
+            status=msg.status,
+            status_code=msg.last_event.code,
+            workflow_id=msg.workflow_id,
+            total_chunks=msg.total_chunks or 0,
         )
-    )
+        for msg in messages
+    ]
 
 
 def get_rich_outbox_view(messages: list[Message], links: dict[str, str]) -> JSONResponse:
@@ -121,7 +118,6 @@ def get_rich_outbox_view(messages: list[Message], links: dict[str, str]) -> JSON
 
 
 def send_message_response(message: Message, model_version: int = 1) -> Union[SendMessageV1, SendMessageV2]:
-
     if model_version < 2:
         return SendMessageV1(messageID=message.message_id)
 
@@ -129,7 +125,6 @@ def send_message_response(message: Message, model_version: int = 1) -> Union[Sen
 
 
 def upload_chunk_response(message: Message, chunk_number: int, model_version: int = 1) -> Optional[UploadChunkV1]:
-
     if model_version < 2:
         return UploadChunkV1(messageID=message.message_id, blockID=chunk_number)
 

mesh_sandbox/views/tracking.py

@@ -9,7 +9,6 @@ _EMPTY: Final[str] = ""
 
 
 class TrackingV1(BaseModel):
-
     addressType: Optional[str] = "ALL"
     checksum: Optional[str] = Field(description="message status e.g. 'accepted' 'acknowledged'")
     chunkCount: Optional[int] = Field(description="number of message chunks")
@@ -62,7 +61,6 @@ class TrackingV1(BaseModel):
 
 
 class TrackingV2(BaseModel):
-
     message_id: str = Field(description="message identifier")
     local_id: Optional[str] = Field(description="local identifier supplied by sender")
     workflow_id: Optional[str] = Field(description="message workflow identifier")
@@ -98,7 +96,6 @@ def _format_timestamp(timestamp: Optional[datetime]) -> str:
 
 
 def create_tracking_response(message: Message, model_version: int = 1) -> Union[TrackingV1, TrackingV2]:
-
     error_event = message.error_event
 
     successful = bool(message.message_type == MessageType.DATA and not error_event)
@@ -123,7 +120,6 @@ def create_tracking_response(message: Message, model_version: int = 1) -> Union[
             status_timestamp_string = _format_timestamp(status_timestamp)
 
     if model_version < 2:
-
         return TrackingV1(
             checksum=message.metadata.checksum or _EMPTY,
             chunkCount=message.total_chunks,

{mesh_sandbox-1.0.10.dist-info → mesh_sandbox-1.0.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mesh-sandbox
-Version: 1.0.10
+Version: 1.0.12
 Summary: NHSDigital mesh sandbox, a locally testable version of the MESH api
 License: MIT
 Author: spinecore
@@ -10,12 +10,12 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: cryptography (>=39.0.1,<42.0.0)
-Requires-Dist: fastapi (>=0.94,<0.101)
-Requires-Dist: gunicorn (>=20.1.0,<21.0.0)
+Requires-Dist: cryptography (>=41.0.4,<42.0.0)
+Requires-Dist: fastapi (>=0.103.1,<0.104.0)
+Requires-Dist: gunicorn (>=21.2.0,<22.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: types-python-dateutil (>=2.8.9,<3.0.0)
-Requires-Dist: uvicorn (>=0.21,<0.23)
+Requires-Dist: uvicorn (>=0.23.2,<0.24.0)
 Description-Content-Type: text/markdown
 
 MESH Sandbox
@@ -51,57 +51,32 @@ services:
     build: 
       context: https://github.com/NHSDigital/mesh-sandbox.git#refs/tags/v1.0.4
     ports:
-      - "8700:80"
+      - "8700:443"
     deploy:
       restart_policy:
         condition: on-failure
         max_attempts: 3
     healthcheck:
-      test: curl -sf http://localhost:80/health || exit 1
+      test: curl -ksf https://localhost/health || exit 1
       interval: 3s
       timeout: 10s
     environment:
       - SHARED_KEY=TestKey
+      - SSL=yes
+#      - STORE_MODE=file  # store mode file will persist data to disk
     volumes:
       # mount a different mailboxes.jsonl to pre created mailboxes
       - ./src/mesh_sandbox/store/data/mailboxes.jsonl:/app/mesh_sandbox/store/data/mailboxes.jsonl:ro
-      # the mesh sandbox supports injecting a plugin to support test hooks 
-      # - ./my_test_plugin.py:/app/mesh_sandbox/plugin/my_test_plygin.py:ro
+      - ./src/mesh_sandbox/test_plugin:/app/mesh_sandbox/plugins:ro
+      # you can mount a directory if you want access the stored messages
+      #      - ./messages:/tmp/mesh_store
+      # you can also mount different server cert and key if using ssl and you need a trusted certificate
+#      - ./mycert.pem:/tmp/server-cert.pem:ro
+#      - ./mycert.key:/tmp/server-cert.key:ro
 
 ```
 
 Guidance for contributors
 -------------------------
-
-this project uses
-
-- python 3.9
-- java coretto11
-- poetry > 1.2
-
-Setup
------
-
-using asdf
-[install asdf](https://asdf-vm.com/guide/getting-started.html#_3-install-asdf)
-
-get the required plugins
-
-```bash
-asdf plugin add python
-asdf plugin add java
-asdf plugin add poetry
-```
-
-install the tools
-
-```bash
-asdf install
-```
-
-install the dependencies
-
-```bash
-make install
-```
+[contributing](CONTRIBUTING.md)