kuhl-haus-mdp 0.1.0__tar.gz → 0.1.1__tar.gz

kuhl_haus_mdp-0.1.1/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.1
+Name: kuhl-haus-mdp
+Version: 0.1.1
+Summary: Market data processing pipeline for stock market scanner
+Author-Email: Tom Pounders <git@oldschool.engineer>
+License: The MIT License (MIT)
+         
+         Copyright (c) 2025 Tom Pounders
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Project-URL: Homepage, https://github.com/kuhl-haus/kuhl-haus-mdp
+Project-URL: Documentation, https://github.com/kuhl-haus/kuhl-haus-mdp/wiki
+Project-URL: Source, https://github.com/kuhl-haus/kuhl-haus-mdp.git
+Project-URL: Changelog, https://github.com/kuhl-haus/kuhl-haus-mdp/commits
+Project-URL: Tracker, https://github.com/kuhl-haus/kuhl-haus-mdp/issues
+Requires-Python: <3.13,>=3.9.21
+Requires-Dist: websockets
+Requires-Dist: aio-pika
+Requires-Dist: redis[asyncio]
+Requires-Dist: tenacity
+Requires-Dist: fastapi
+Requires-Dist: uvicorn[standard]
+Requires-Dist: pydantic-settings
+Requires-Dist: python-dotenv
+Requires-Dist: massive
+Provides-Extra: testing
+Requires-Dist: setuptools; extra == "testing"
+Requires-Dist: pdm-backend; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Description-Content-Type: text/markdown
+
+<!-- These are examples of badges you might want to add to your README:
+   please update the URLs accordingly 
+
+[![ReadTheDocs](https://readthedocs.org/projects/kuhl-haus-mdp/badge/?version=latest)](https://kuhl-haus-mdp.readthedocs.io/en/stable/)
+[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/kuhl-haus-mdp.svg)](https://anaconda.org/conda-forge/kuhl-haus-mdp)
+[![Monthly Downloads](https://pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
+-->
+
+
+[![License](https://img.shields.io/github/license/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/blob/mainline/LICENSE.txt)
+[![PyPI](https://img.shields.io/pypi/v/kuhl-haus-mdp.svg)](https://pypi.org/project/kuhl-haus-mdp/)
+[![Downloads](https://static.pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
+[![Build Status](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml)
+[![CodeQL Advanced](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml)
+[![codecov](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp/branch/mainline/graph/badge.svg)](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp)
+[![GitHub issues](https://img.shields.io/github/issues/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/issues)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/pulls)
+
+
+# kuhl-haus-mdp
+
+Market data processing pipeline for stock market scanner.
+
+
+
+## TL;DR
+Non-business Massive (AKA Polygon.IO) accounts are limited to a single WebSocket connection per asset class and it has to be fast enough to handle messages in a non-blocking fashion or it'll get disconnected.  The market data processing pipeline consists of loosely-coupled market data processing components so that a single WebSocket connection can handle messages fast enough to maintain a reliable connection with the market data provider.
+
+Per, https://massive.com/docs/websocket/quickstart#connecting-to-the-websocket:
+> *By default, one concurrent WebSocket connection per asset class is allowed. If you require multiple simultaneous connections for the same asset class, please [contact support](https://massive.com/contact).*
+
+# Components Summary
+
+Non-business Massive (AKA Polygon.IO) accounts are limited to a single WebSocket connection per asset class and it has to be fast enough to handle messages in a non-blocking fashion or it'll get disconnected.  The Market Data Listener (MDL) connects to the Market Data Source (Massive) and subscribes to unfiltered feeds. MDL inspects the message type for selecting the appropriate serialization method and destination Market Data Queue (MDQ).  The Market Data Processors (MDP) subscribe to raw market data in the MDQ and perform the heavy lifting that would otherwise constrain the message handling speed of the MDL.  This decoupling allows the MDP and MDL to scale independently.  Post-processed market data is stored in the MDC for consumption by the Widget Data Service (WDS).  Client-side widgets receive market data from the WDS, which provides a WebSocket interface to MDC pub/sub streams and cached data.
+
+[![Market Data Processing C4-V1.drawio.png](docs/Market_Data_Processing_C4.png)]
+
+# Component Descriptions
+
+## Market Data Listener (MDL)
+The MDL performs minimal processing on the messages.  MDL inspects the message type for selecting the appropriate serialization method and destination queue.  MDL implementations may vary as new MDS become available (for example, news).
+
+MDL runs as a container and scales independently of other components. The MDL should not be accessible outside the data plane local network.
+
+## Market Data Queues (MDQ)
+
+**Purpose:** Buffer high-velocity market data stream for server-side processing with aggressive freshness controls
+- **Queue Type:** FIFO with TTL (5-second max message age)
+- **Cleanup Strategy:** Discarded when TTL expires
+- **Message Format:** Timestamped JSON preserving original Massive.com structure
+- **Durability:** Non-persistent messages (speed over reliability for real-time data)
+- **Independence:** Queues operate completely independently - one queue per subscription
+- **Technology**: RabbitMQ
+
+The MDQ should not be accessible outside the data plane local network.
+
+## Market Data Processors (MDP)
+The purpose of the MDP is to process raw real-time market data and delegate processing to data-specific handlers.  This separation of concerns allows MDPs to handle any type of data and simplifies horizontal scaling.  The MDP stores its processed results in the Market Data Cache (MDC).
+
+The MDP:
+- Hydrates the in-memory cache on MDC
+- Processes market data 
+- Publishes messages to pub/sub channels
+- Maintains cache entries in MDC
+
+MDPs runs as containers and scale independently of other components. The MDPs should not be accessible outside the data plane local network.
+
+## Market Data Cache (MDC)
+
+**Purpose:** In-memory data store for serialized processed market data.
+* **Cache Type**: In-memory persistent or with TTL
+- **Queue Type:** pub/sub
+- **Technology**: Redis
+
+The MDC should not be accessible outside the data plane local network.
+
+## Widget Data Service (WDS)
+**Purpose**:
+1. WebSocket interface provides access to processed market data for client-side code
+2. Is the network-layer boundary between clients and the data that is available on the data plane
+
+WDS runs as a container and scales independently of other components.  WDS is the only data plane component that should be exposed to client networks.
+
+
+## Service Control Plane (SCP)
+**Purpose**: 
+1. Authentication and authorization
+2. Serve static and dynamic content via py4web
+3. Serve SPA to authenticated clients
+4. Injects authentication token and WDS url into SPA environment for authenticated access to WDS
+5. Control plane for managing application components at runtime
+6. API for programmatic access to service controls and instrumentation.
+
+The SCP requires access to the data plane network for API access to data plane components.
+

kuhl_haus_mdp-0.1.1/README.md

@@ -0,0 +1,95 @@
+<!-- These are examples of badges you might want to add to your README:
+   please update the URLs accordingly 
+
+[![ReadTheDocs](https://readthedocs.org/projects/kuhl-haus-mdp/badge/?version=latest)](https://kuhl-haus-mdp.readthedocs.io/en/stable/)
+[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/kuhl-haus-mdp.svg)](https://anaconda.org/conda-forge/kuhl-haus-mdp)
+[![Monthly Downloads](https://pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
+-->
+
+
+[![License](https://img.shields.io/github/license/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/blob/mainline/LICENSE.txt)
+[![PyPI](https://img.shields.io/pypi/v/kuhl-haus-mdp.svg)](https://pypi.org/project/kuhl-haus-mdp/)
+[![Downloads](https://static.pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
+[![Build Status](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml)
+[![CodeQL Advanced](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml)
+[![codecov](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp/branch/mainline/graph/badge.svg)](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp)
+[![GitHub issues](https://img.shields.io/github/issues/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/issues)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/pulls)
+
+
+# kuhl-haus-mdp
+
+Market data processing pipeline for stock market scanner.
+
+
+
+## TL;DR
+Non-business Massive (AKA Polygon.IO) accounts are limited to a single WebSocket connection per asset class and it has to be fast enough to handle messages in a non-blocking fashion or it'll get disconnected.  The market data processing pipeline consists of loosely-coupled market data processing components so that a single WebSocket connection can handle messages fast enough to maintain a reliable connection with the market data provider.
+
+Per, https://massive.com/docs/websocket/quickstart#connecting-to-the-websocket:
+> *By default, one concurrent WebSocket connection per asset class is allowed. If you require multiple simultaneous connections for the same asset class, please [contact support](https://massive.com/contact).*
+
+# Components Summary
+
+Non-business Massive (AKA Polygon.IO) accounts are limited to a single WebSocket connection per asset class and it has to be fast enough to handle messages in a non-blocking fashion or it'll get disconnected.  The Market Data Listener (MDL) connects to the Market Data Source (Massive) and subscribes to unfiltered feeds. MDL inspects the message type for selecting the appropriate serialization method and destination Market Data Queue (MDQ).  The Market Data Processors (MDP) subscribe to raw market data in the MDQ and perform the heavy lifting that would otherwise constrain the message handling speed of the MDL.  This decoupling allows the MDP and MDL to scale independently.  Post-processed market data is stored in the MDC for consumption by the Widget Data Service (WDS).  Client-side widgets receive market data from the WDS, which provides a WebSocket interface to MDC pub/sub streams and cached data.
+
+[![Market Data Processing C4-V1.drawio.png](docs/Market_Data_Processing_C4.png)]
+
+# Component Descriptions
+
+## Market Data Listener (MDL)
+The MDL performs minimal processing on the messages.  MDL inspects the message type for selecting the appropriate serialization method and destination queue.  MDL implementations may vary as new MDS become available (for example, news).
+
+MDL runs as a container and scales independently of other components. The MDL should not be accessible outside the data plane local network.
+
+## Market Data Queues (MDQ)
+
+**Purpose:** Buffer high-velocity market data stream for server-side processing with aggressive freshness controls
+- **Queue Type:** FIFO with TTL (5-second max message age)
+- **Cleanup Strategy:** Discarded when TTL expires
+- **Message Format:** Timestamped JSON preserving original Massive.com structure
+- **Durability:** Non-persistent messages (speed over reliability for real-time data)
+- **Independence:** Queues operate completely independently - one queue per subscription
+- **Technology**: RabbitMQ
+
+The MDQ should not be accessible outside the data plane local network.
+
+## Market Data Processors (MDP)
+The purpose of the MDP is to process raw real-time market data and delegate processing to data-specific handlers.  This separation of concerns allows MDPs to handle any type of data and simplifies horizontal scaling.  The MDP stores its processed results in the Market Data Cache (MDC).
+
+The MDP:
+- Hydrates the in-memory cache on MDC
+- Processes market data 
+- Publishes messages to pub/sub channels
+- Maintains cache entries in MDC
+
+MDPs runs as containers and scale independently of other components. The MDPs should not be accessible outside the data plane local network.
+
+## Market Data Cache (MDC)
+
+**Purpose:** In-memory data store for serialized processed market data.
+* **Cache Type**: In-memory persistent or with TTL
+- **Queue Type:** pub/sub
+- **Technology**: Redis
+
+The MDC should not be accessible outside the data plane local network.
+
+## Widget Data Service (WDS)
+**Purpose**:
+1. WebSocket interface provides access to processed market data for client-side code
+2. Is the network-layer boundary between clients and the data that is available on the data plane
+
+WDS runs as a container and scales independently of other components.  WDS is the only data plane component that should be exposed to client networks.
+
+
+## Service Control Plane (SCP)
+**Purpose**: 
+1. Authentication and authorization
+2. Serve static and dynamic content via py4web
+3. Serve SPA to authenticated clients
+4. Injects authentication token and WDS url into SPA environment for authenticated access to WDS
+5. Control plane for managing application components at runtime
+6. API for programmatic access to service controls and instrumentation.
+
+The SCP requires access to the data plane network for API access to data plane components.
+

{kuhl_haus_mdp-0.1.0 → kuhl_haus_mdp-0.1.1}/pyproject.toml

@@ -29,7 +29,7 @@ dependencies = [
     "python-dotenv",
     "massive",
 ]
-version = "0.1.0"
+version = "0.1.1"
 
 [project.license]
 file = "LICENSE.txt"

{kuhl_haus_mdp-0.1.0 → kuhl_haus_mdp-0.1.1}/src/kuhl_haus/mdp/integ/web_socket_message_serde.py

@@ -59,8 +59,8 @@ class WebSocketMessageSerde:
         ret: dict = {
             "event_type": message.event_type,
             "symbol": message.symbol,
-            "high": message.high_price,
-            "low": message.low_price,
+            "high_price": message.high_price,
+            "low_price": message.low_price,
             "indicators": message.indicators,
             "tape": message.tape,
             "timestamp": message.timestamp,

kuhl_haus_mdp-0.1.1/tests/components/test_market_data_scanner.py

@@ -0,0 +1,55 @@
+# tests/test_market_data_scanner.py
+import asyncio
+import json
+import unittest
+from unittest.mock import AsyncMock, patch, MagicMock
+
+from kuhl_haus.mdp.analyzers.analyzer import Analyzer
+from kuhl_haus.mdp.components.market_data_scanner import MarketDataScanner
+
+
+class TestMarketDataScanner(unittest.IsolatedAsyncioTestCase):
+    """Unit tests for the MarketDataScanner class."""
+
+    def setUp(self):
+        """Set up a MarketDataScanner instance for testing."""
+        self.redis_url = "redis://localhost:6379/0"
+        self.analyzer = MagicMock(spec=Analyzer)
+        self.analyzer.cache_key = MagicMock()
+        self.analyzer.rehydrate = AsyncMock()
+        self.analyzer.analyze_data = AsyncMock()
+        self.subscriptions = ["channel_1"]
+        self.scanner = MarketDataScanner(
+            redis_url=self.redis_url,
+            analyzer=self.analyzer,
+            subscriptions=self.subscriptions,
+        )
+
+    @patch("kuhl_haus.mdp.components.market_data_scanner.asyncio.sleep", new_callable=AsyncMock)
+    @patch("kuhl_haus.mdp.components.market_data_scanner.MarketDataScanner.start", new_callable=AsyncMock)
+    @patch("kuhl_haus.mdp.components.market_data_scanner.MarketDataScanner.stop", new_callable=AsyncMock)
+    async def test_restart(self, mock_stop, mock_start, mock_sleep):
+        """Test the restart method stops and starts the scanner."""
+        self.scanner.start = mock_start
+        self.scanner.stop = mock_stop
+        mock_stop.return_value = None
+
+        await self.scanner.restart()
+
+        mock_stop.assert_called_once()
+        mock_start.assert_called_once()
+        self.assertEqual(self.scanner.restarts, 1)
+
+    async def test_process_message_success(self):
+        """Test _process_message handles and processes valid data."""
+        valid_data = {"key": "value"}
+        analyzer_results = [MagicMock(), MagicMock()]
+        self.analyzer.analyze_data = AsyncMock(return_value=analyzer_results)
+        self.scanner.cache_result = AsyncMock()
+
+        await self.scanner._process_message(valid_data)
+
+        self.analyzer.analyze_data.assert_called_once_with(valid_data)
+        self.scanner.cache_result.assert_any_call(analyzer_results[0])
+        self.scanner.cache_result.assert_any_call(analyzer_results[1])
+        self.assertEqual(self.scanner.processed, 1)

kuhl_haus_mdp-0.1.1/tests/test_queue_name_resolver.py

@@ -0,0 +1,51 @@
+# tests/test_queue_name_resolver.py
+
+import unittest
+from unittest.mock import MagicMock
+
+from kuhl_haus.mdp.helpers.queue_name_resolver import QueueNameResolver
+from kuhl_haus.mdp.models.massive_data_queue import MassiveDataQueue
+from massive.websocket.models import EquityAgg, EquityTrade, EquityQuote, LimitUpLimitDown, WebSocketMessage
+
+
+class TestQueueNameResolver(unittest.TestCase):
+    """Unit tests for the QueueNameResolver class."""
+
+    def test_resolves_trades_queue(self):
+        """Test that EquityTrade messages resolve to the TRADES queue."""
+        message = MagicMock(spec=EquityTrade)
+        expected_queue = MassiveDataQueue.TRADES.value
+        resolved_queue = QueueNameResolver.queue_name_for_web_socket_message(message)
+        self.assertEqual(expected_queue, resolved_queue)
+
+    def test_resolves_aggregate_queue(self):
+        """Test that EquityAgg messages resolve to the AGGREGATE queue."""
+        message = MagicMock(spec=EquityAgg)
+        expected_queue = MassiveDataQueue.AGGREGATE.value
+        resolved_queue = QueueNameResolver.queue_name_for_web_socket_message(message)
+        self.assertEqual(expected_queue, resolved_queue)
+
+    def test_resolves_quotes_queue(self):
+        """Test that EquityQuote messages resolve to the QUOTES queue."""
+        message = MagicMock(spec=EquityQuote)
+        expected_queue = MassiveDataQueue.QUOTES.value
+        resolved_queue = QueueNameResolver.queue_name_for_web_socket_message(message)
+        self.assertEqual(expected_queue, resolved_queue)
+
+    def test_resolves_halts_queue(self):
+        """Test that LimitUpLimitDown messages resolve to the HALTS queue."""
+        message = MagicMock(spec=LimitUpLimitDown)
+        expected_queue = MassiveDataQueue.HALTS.value
+        resolved_queue = QueueNameResolver.queue_name_for_web_socket_message(message)
+        self.assertEqual(expected_queue, resolved_queue)
+
+    def test_resolves_unknown_queue(self):
+        """Test that unsupported WebSocketMessage resolves to the UNKNOWN queue."""
+        message = MagicMock(spec=WebSocketMessage)  # Unsupported type
+        expected_queue = MassiveDataQueue.UNKNOWN.value
+        resolved_queue = QueueNameResolver.queue_name_for_web_socket_message(message)
+        self.assertEqual(expected_queue, resolved_queue)
+
+
+if __name__ == '__main__':
+    unittest.main()

kuhl_haus_mdp-0.1.1/tests/test_web_socket_message_serde.py

@@ -0,0 +1,440 @@
+# tests/test_web_socket_message_serde.py
+import json
+from argparse import ArgumentTypeError
+import unittest
+from unittest.mock import MagicMock
+
+from massive.websocket.models import (
+    EquityTrade,
+    EquityQuote,
+    EquityAgg,
+    LimitUpLimitDown,
+    EventType,
+)
+from src.kuhl_haus.mdp.integ.web_socket_message_serde import WebSocketMessageSerde
+
+
+class TestWebSocketMessageSerde(unittest.TestCase):
+    """Unit tests for the WebSocketMessageSerde class."""
+
+    # Equity Trades
+    def test_serialize_with_equity_trade_happy_path(self):
+        """Test serialization of EquityTrade messages."""
+        message = MagicMock(
+            spec=EquityTrade,
+            event_type=EventType.EquityTrade.value,
+            symbol="TEST",
+            exchange="NYSE",
+            id="12345",
+            tape="T",
+            price=100.0,
+            size=10,
+            conditions=["C1", "C2"],
+            timestamp=1234567890,
+            sequence_number=1,
+            trf_id="54321",
+            trf_timestamp=1234567891,
+        )
+        serialized_message = WebSocketMessageSerde.serialize(message)
+        expected_message = {
+            "event_type": EventType.EquityTrade.value,
+            "symbol": "TEST",
+            "exchange": "NYSE",
+            "id": "12345",
+            "tape": "T",
+            "price": 100.0,
+            "size": 10,
+            "conditions": ["C1", "C2"],
+            "timestamp": 1234567890,
+            "sequence_number": 1,
+            "trf_id": "54321",
+            "trf_timestamp": 1234567891,
+        }
+        self.assertEqual(expected_message, json.loads(serialized_message))
+
+    def test_to_dict_with_equity_trade_happy_path(self):
+        """Test conversion to a Python dictionary for EquityTrade messages."""
+        message = MagicMock(
+            spec=EquityTrade,
+            event_type=EventType.EquityTrade.value,
+            symbol="TEST",
+            exchange="NYSE",
+            id="12345",
+            tape="T",
+            price=100.0,
+            size=10,
+            conditions=["C1", "C2"],
+            timestamp=1234567890,
+            sequence_number=1,
+            trf_id="54321",
+            trf_timestamp=1234567891,
+        )
+        expected_dict = {
+            "event_type": EventType.EquityTrade.value,
+            "symbol": "TEST",
+            "exchange": "NYSE",
+            "id": "12345",
+            "tape": "T",
+            "price": 100.0,
+            "size": 10,
+            "conditions": ["C1", "C2"],
+            "timestamp": 1234567890,
+            "sequence_number": 1,
+            "trf_id": "54321",
+            "trf_timestamp": 1234567891,
+        }
+        self.assertEqual(expected_dict, WebSocketMessageSerde.to_dict(message))
+
+    def test_deserialize_with_equity_trade_happy_path(self):
+        """Test deserialization of a EquityTrade message."""
+        serialized_message = json.dumps(
+            {
+                "event_type": EventType.EquityTrade.value,
+                "symbol": "TEST",
+                "exchange": "NYSE",
+                "id": "12345",
+                "tape": "T",
+                "price": 100.0,
+                "size": 10,
+                "conditions": ["C1", "C2"],
+                "timestamp": 1234567890,
+                "sequence_number": 1,
+                "trf_id": "54321",
+                "trf_timestamp": 1234567891,
+            }
+        )
+        deserialized_message = WebSocketMessageSerde.deserialize(serialized_message)
+        self.assertIsInstance(deserialized_message, EquityTrade)
+        self.assertEqual(deserialized_message.event_type, EventType.EquityTrade.value)
+        self.assertEqual(deserialized_message.symbol, "TEST")
+        self.assertEqual(deserialized_message.exchange, "NYSE")
+        self.assertEqual(deserialized_message.id, "12345")
+        self.assertEqual(deserialized_message.tape, "T")
+        self.assertEqual(deserialized_message.price, 100.0)
+        self.assertEqual(deserialized_message.size, 10)
+        self.assertEqual(deserialized_message.conditions, ["C1", "C2"])
+        self.assertEqual(deserialized_message.timestamp, 1234567890)
+        self.assertEqual(deserialized_message.sequence_number, 1)
+        self.assertEqual(deserialized_message.trf_id, "54321")
+        self.assertEqual(deserialized_message.trf_timestamp, 1234567891)
+
+    # Equity Quotes
+    def test_serialize_with_equity_quote_happy_path(self):
+        """Test serialization for EquityQuote."""
+        message = MagicMock(
+            spec=EquityQuote,
+            event_type=EventType.EquityQuote.value,
+            symbol="TEST",
+            bid_exchange_id=11,
+            bid_price=101.0,
+            bid_size=50,
+            ask_exchange_id=12,
+            ask_price=102.0,
+            ask_size=60,
+            condition="C1",
+            indicators=["I1"],
+            timestamp=1234567892,
+            sequence_number=2,
+            tape="T1",
+        )
+        serialized_message = WebSocketMessageSerde.serialize(message)
+        expected_message = {
+            "event_type": EventType.EquityQuote.value,
+            "symbol": "TEST",
+            "bid_exchange_id": 11,
+            "bid_price": 101.0,
+            "bid_size": 50,
+            "ask_exchange_id": 12,
+            "ask_price": 102.0,
+            "ask_size": 60,
+            "condition": "C1",
+            "indicators": ["I1"],
+            "timestamp": 1234567892,
+            "sequence_number": 2,
+            "tape": "T1",
+        }
+        self.assertEqual(expected_message, json.loads(serialized_message))
+
+    def test_to_dict_with_equity_quote_happy_path(self):
+        """Test conversion to a Python dictionary for EquityQuote."""
+        message = MagicMock(
+            spec=EquityQuote,
+            event_type=EventType.EquityQuote.value,
+            symbol="TEST",
+            bid_exchange_id=11,
+            bid_price=101.0,
+            bid_size=50,
+            ask_exchange_id=12,
+            ask_price=102.0,
+            ask_size=60,
+            condition="C1",
+            indicators=["I1"],
+            timestamp=1234567892,
+            sequence_number=2,
+            tape="T1",
+        )
+        expected_dict = {
+            "event_type": EventType.EquityQuote.value,
+            "symbol": "TEST",
+            "bid_exchange_id": 11,
+            "bid_price": 101.0,
+            "bid_size": 50,
+            "ask_exchange_id": 12,
+            "ask_price": 102.0,
+            "ask_size": 60,
+            "condition": "C1",
+            "indicators": ["I1"],
+            "timestamp": 1234567892,
+            "sequence_number": 2,
+            "tape": "T1",
+        }
+        self.assertEqual(expected_dict, WebSocketMessageSerde.to_dict(message))
+
+    def test_deserialize_with_equity_quote_happy_path(self):
+        """Test deserialization for EquityQuote."""
+        serialized_message = json.dumps(
+            {
+                "event_type": EventType.EquityQuote.value,
+                "symbol": "TEST",
+                "bid_exchange_id": 11,
+                "bid_price": 101.0,
+                "bid_size": 50,
+                "ask_exchange_id": 12,
+                "ask_price": 102.0,
+                "ask_size": 60,
+                "condition": "C1",
+                "indicators": ["I1"],
+                "timestamp": 1234567892,
+                "sequence_number": 2,
+                "tape": "T1",
+            }
+        )
+        deserialized_message = WebSocketMessageSerde.deserialize(serialized_message)
+        self.assertIsInstance(deserialized_message, EquityQuote)
+        self.assertEqual(deserialized_message.event_type, EventType.EquityQuote.value)
+        self.assertEqual(deserialized_message.symbol, "TEST")
+        self.assertEqual(deserialized_message.bid_exchange_id, 11)
+        self.assertEqual(deserialized_message.bid_price, 101.0)
+        self.assertEqual(deserialized_message.bid_size, 50)
+        self.assertEqual(deserialized_message.ask_exchange_id, 12)
+        self.assertEqual(deserialized_message.ask_price, 102.0)
+        self.assertEqual(deserialized_message.ask_size, 60)
+        self.assertEqual(deserialized_message.condition, "C1")
+        self.assertEqual(deserialized_message.indicators, ["I1"])
+        self.assertEqual(deserialized_message.timestamp, 1234567892)
+        self.assertEqual(deserialized_message.sequence_number, 2)
+        self.assertEqual(deserialized_message.tape, "T1")
+
+    # Equity Aggregates
+    def test_serialize_with_equity_agg_happy_path(self):
+        """Test serialization for EquityAgg."""
+        message = MagicMock(
+            spec=EquityAgg,
+            event_type=EventType.EquityAgg.value,
+            symbol="TEST",
+            volume=100,
+            accumulated_volume=1000,
+            official_open_price=10.00,
+            vwap=10.25,
+            open=10.26,
+            close=10.27,
+            high=10.28,
+            low=10.29,
+            aggregate_vwap=10.30,
+            average_size=10.31,
+            start_timestamp=1234567890,
+            end_timestamp=1234567891,
+            otc=True,
+        )
+        serialized_message = WebSocketMessageSerde.serialize(message)
+        expected_message = {
+            "event_type": EventType.EquityAgg.value,
+            "symbol": "TEST",
+            "volume": 100,
+            "accumulated_volume": 1000,
+            "official_open_price": 10.00,
+            "vwap": 10.25,
+            "open": 10.26,
+            "close": 10.27,
+            "high": 10.28,
+            "low": 10.29,
+            "aggregate_vwap": 10.30,
+            "average_size": 10.31,
+            "start_timestamp": 1234567890,
+            "end_timestamp": 1234567891,
+            "otc": True,
+        }
+        self.assertEqual(expected_message, json.loads(serialized_message))
+
+    def test_to_dict_with_equity_agg_happy_path(self):
+        """Test conversion to a Python dictionary for EquityAgg."""
+        message = MagicMock(
+            spec=EquityAgg,
+            event_type=EventType.EquityAgg.value,
+            symbol="TEST",
+            volume=100,
+            accumulated_volume=1000,
+            official_open_price=10.00,
+            vwap=10.25,
+            open=10.26,
+            close=10.27,
+            high=10.28,
+            low=10.29,
+            aggregate_vwap=10.30,
+            average_size=10.31,
+            start_timestamp=1234567890,
+            end_timestamp=1234567891,
+            otc=True,
+        )
+        expected_dict = {
+            "event_type": EventType.EquityAgg.value,
+            "symbol": "TEST",
+            "volume": 100,
+            "accumulated_volume": 1000,
+            "official_open_price": 10.00,
+            "vwap": 10.25,
+            "open": 10.26,
+            "close": 10.27,
+            "high": 10.28,
+            "low": 10.29,
+            "aggregate_vwap": 10.30,
+            "average_size": 10.31,
+            "start_timestamp": 1234567890,
+            "end_timestamp": 1234567891,
+            "otc": True,
+        }
+        self.assertEqual(expected_dict, WebSocketMessageSerde.to_dict(message))
+
+    def test_deserialize_with_equity_agg_happy_path(self):
+        """Test deserialization for EquityAgg."""
+        serialized_message = json.dumps({
+            "event_type": EventType.EquityAgg.value,
+            "symbol": "TEST",
+            "volume": 100,
+            "accumulated_volume": 1000,
+            "official_open_price": 10.00,
+            "vwap": 10.25,
+            "open": 10.26,
+            "close": 10.27,
+            "high": 10.28,
+            "low": 10.29,
+            "aggregate_vwap": 10.30,
+            "average_size": 10.31,
+            "start_timestamp": 1234567890,
+            "end_timestamp": 1234567891,
+            "otc": True,
+        })
+        deserialized_message = WebSocketMessageSerde.deserialize(serialized_message)
+        self.assertIsInstance(deserialized_message, EquityAgg)
+        self.assertEqual(deserialized_message.event_type, EventType.EquityAgg.value)
+        self.assertEqual(deserialized_message.symbol, "TEST")
+        self.assertEqual(deserialized_message.volume, 100)
+        self.assertEqual(deserialized_message.accumulated_volume, 1000)
+        self.assertEqual(deserialized_message.official_open_price, 10.00)
+        self.assertEqual(deserialized_message.vwap, 10.25)
+        self.assertEqual(deserialized_message.open, 10.26)
+        self.assertEqual(deserialized_message.close, 10.27)
+        self.assertEqual(deserialized_message.high, 10.28)
+        self.assertEqual(deserialized_message.low, 10.29)
+        self.assertEqual(deserialized_message.aggregate_vwap, 10.30)
+        self.assertEqual(deserialized_message.average_size, 10.31)
+        self.assertEqual(deserialized_message.start_timestamp, 1234567890)
+        self.assertEqual(deserialized_message.end_timestamp, 1234567891)
+        self.assertEqual(deserialized_message.otc, True)
+
+    # LULD
+    def test_serialize_with_limit_up_limit_down_happy_path(self):
+        """Test serialization of LimitUpLimitDown messages."""
+        message = MagicMock(
+            spec=LimitUpLimitDown,
+            event_type=EventType.LimitUpLimitDown.value,
+            symbol="TEST",
+            high_price=100.0,
+            low_price=90.0,
+            indicators=["I1"],
+            tape="T",
+            timestamp=1234567890,
+            sequence_number=1,
+        )
+        serialized_message = WebSocketMessageSerde.serialize(message)
+        expected_message = {
+            "event_type": EventType.LimitUpLimitDown.value,
+            "symbol": "TEST",
+            "high_price": 100.0,
+            "low_price": 90.0,
+            "indicators": ["I1"],
+            "tape": "T",
+            "timestamp": 1234567890,
+            "sequence_number": 1,
+        }
+        self.assertEqual(expected_message, json.loads(serialized_message))
+
+    def test_to_dict_with_limit_up_limit_down_happy_path(self):
+        """Test conversion to a Python dictionary for LimitUpLimitDown messages."""
+        message = MagicMock(
+            spec=LimitUpLimitDown,
+            event_type=EventType.LimitUpLimitDown.value,
+            symbol="TEST",
+            high_price=100.0,
+            low_price=90.0,
+            indicators=["I1"],
+            tape="T",
+            timestamp=1234567890,
+            sequence_number=1,
+        )
+        expected_dict = {
+            "event_type": EventType.LimitUpLimitDown.value,
+            "symbol": "TEST",
+            "high_price": 100.0,
+            "low_price": 90.0,
+            "indicators": ["I1"],
+            "tape": "T",
+            "timestamp": 1234567890,
+            "sequence_number": 1,
+        }
+        self.assertEqual(expected_dict, WebSocketMessageSerde.to_dict(message))
+
+    def test_deserialize_with_limit_up_limit_down_happy_path(self):
+        """Test deserialization of a LimitUpLimitDown message."""
+        serialized_message = json.dumps(
+            {
+                "event_type": EventType.LimitUpLimitDown.value,
+                "symbol": "TEST",
+                "high_price": 200.0,
+                "low_price": 150.0,
+                "indicators": ["I1"],
+                "tape": "T1",
+                "timestamp": 1234567893,
+                "sequence_number": 3,
+            }
+        )
+        deserialized_message = WebSocketMessageSerde.deserialize(serialized_message)
+        self.assertIsInstance(deserialized_message, LimitUpLimitDown)
+        self.assertEqual(deserialized_message.event_type, EventType.LimitUpLimitDown.value)
+        self.assertEqual(deserialized_message.symbol, "TEST")
+        self.assertEqual(deserialized_message.high_price, 200.0)
+        self.assertEqual(deserialized_message.low_price, 150.0)
+
+    # Unsupported message types
+    def test_deserialize_with_unsupported_message_type_expect_exception(self):
+        """Test deserialization raises an error for unsupported message types."""
+        event_type = "UnsupportedEventType"
+        serialized_message = json.dumps({"event_type": event_type})
+        with self.assertRaises(ArgumentTypeError) as e:
+            WebSocketMessageSerde.deserialize(serialized_message)
+
+            assert e.exception.args[0] == f"Unsupported message type: {event_type}"
+
+    def test_to_dict_with_unsupported_message_type_expect_dict(self):
+        """Test conversion to a Python dictionary for unsupported message types."""
+        event_type = "UnsupportedEventType"
+        message = json.loads(json.dumps({"event_type": event_type}))
+        expected_dict = {"event_type": event_type}
+        self.assertEqual(expected_dict, WebSocketMessageSerde.to_dict(message))
+
+    def test_serialize_with_unsupported_message_type_expect_string(self):
+        """Test serialization for unsupported message types."""
+        event_type = "UnsupportedEventType"
+        message = json.loads(json.dumps({"event_type": event_type}))
+        expected_string = '{"event_type": "UnsupportedEventType"}'
+        self.assertEqual(expected_string, WebSocketMessageSerde.serialize(message))

kuhl_haus_mdp-0.1.0/PKG-INFO

@@ -1,79 +0,0 @@
-Metadata-Version: 2.1
-Name: kuhl-haus-mdp
-Version: 0.1.0
-Summary: Market data processing pipeline for stock market scanner
-Author-Email: Tom Pounders <git@oldschool.engineer>
-License: The MIT License (MIT)
-         
-         Copyright (c) 2025 Tom Pounders
-         
-         Permission is hereby granted, free of charge, to any person obtaining a copy
-         of this software and associated documentation files (the "Software"), to deal
-         in the Software without restriction, including without limitation the rights
-         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-         copies of the Software, and to permit persons to whom the Software is
-         furnished to do so, subject to the following conditions:
-         
-         The above copyright notice and this permission notice shall be included in all
-         copies or substantial portions of the Software.
-         
-         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-         SOFTWARE.
-         
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Project-URL: Homepage, https://github.com/kuhl-haus/kuhl-haus-mdp
-Project-URL: Documentation, https://github.com/kuhl-haus/kuhl-haus-mdp/wiki
-Project-URL: Source, https://github.com/kuhl-haus/kuhl-haus-mdp.git
-Project-URL: Changelog, https://github.com/kuhl-haus/kuhl-haus-mdp/commits
-Project-URL: Tracker, https://github.com/kuhl-haus/kuhl-haus-mdp/issues
-Requires-Python: <3.13,>=3.9.21
-Requires-Dist: websockets
-Requires-Dist: aio-pika
-Requires-Dist: redis[asyncio]
-Requires-Dist: tenacity
-Requires-Dist: fastapi
-Requires-Dist: uvicorn[standard]
-Requires-Dist: pydantic-settings
-Requires-Dist: python-dotenv
-Requires-Dist: massive
-Provides-Extra: testing
-Requires-Dist: setuptools; extra == "testing"
-Requires-Dist: pdm-backend; extra == "testing"
-Requires-Dist: pytest; extra == "testing"
-Requires-Dist: pytest-cov; extra == "testing"
-Description-Content-Type: text/markdown
-
-<!-- These are examples of badges you might want to add to your README:
-   please update the URLs accordingly 
-
-[![ReadTheDocs](https://readthedocs.org/projects/kuhl-haus-mdp/badge/?version=latest)](https://kuhl-haus-mdp.readthedocs.io/en/stable/)
-[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/kuhl-haus-mdp.svg)](https://anaconda.org/conda-forge/kuhl-haus-mdp)
-[![Monthly Downloads](https://pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
--->
-
-
-[![License](https://img.shields.io/github/license/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/blob/mainline/LICENSE.txt)
-[![PyPI](https://img.shields.io/pypi/v/kuhl-haus-mdp.svg)](https://pypi.org/project/kuhl-haus-mdp/)
-[![Downloads](https://static.pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
-[![Build Status](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml)
-[![CodeQL Advanced](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml)
-[![codecov](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp/branch/mainline/graph/badge.svg)](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp)
-[![GitHub issues](https://img.shields.io/github/issues/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/issues)
-[![GitHub pull requests](https://img.shields.io/github/issues-pr/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/pulls)
-
-
-# kuhl-haus-mdp
-
-Market data processing pipeline for stock market scanner.
-
-
-## Note
-
-This project has been set up using PyScaffold 4.6. For details and usage
-information on PyScaffold see https://pyscaffold.org/.

kuhl_haus_mdp-0.1.0/README.md

@@ -1,28 +0,0 @@
-<!-- These are examples of badges you might want to add to your README:
-   please update the URLs accordingly 
-
-[![ReadTheDocs](https://readthedocs.org/projects/kuhl-haus-mdp/badge/?version=latest)](https://kuhl-haus-mdp.readthedocs.io/en/stable/)
-[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/kuhl-haus-mdp.svg)](https://anaconda.org/conda-forge/kuhl-haus-mdp)
-[![Monthly Downloads](https://pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
--->
-
-
-[![License](https://img.shields.io/github/license/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/blob/mainline/LICENSE.txt)
-[![PyPI](https://img.shields.io/pypi/v/kuhl-haus-mdp.svg)](https://pypi.org/project/kuhl-haus-mdp/)
-[![Downloads](https://static.pepy.tech/badge/kuhl-haus-mdp/month)](https://pepy.tech/project/kuhl-haus-mdp)
-[![Build Status](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/publish-to-pypi.yml)
-[![CodeQL Advanced](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml/badge.svg)](https://github.com/kuhl-haus/kuhl-haus-mdp/actions/workflows/codeql.yml)
-[![codecov](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp/branch/mainline/graph/badge.svg)](https://codecov.io/gh/kuhl-haus/kuhl-haus-mdp)
-[![GitHub issues](https://img.shields.io/github/issues/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/issues)
-[![GitHub pull requests](https://img.shields.io/github/issues-pr/kuhl-haus/kuhl-haus-mdp)](https://github.com/kuhl-haus/kuhl-haus-mdp/pulls)
-
-
-# kuhl-haus-mdp
-
-Market data processing pipeline for stock market scanner.
-
-
-## Note
-
-This project has been set up using PyScaffold 4.6. For details and usage
-information on PyScaffold see https://pyscaffold.org/.