Add empty stubs and project skeleton

Author: tipatterson-dev

.gitignore

@@ -158,3 +158,9 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+.idea/
+
+.python-version
+
+poetry.lock

oshconnect/__init__.py

@@ -0,0 +1,29 @@
+from abc import ABC
+
+from dataclasses import dataclass
+from enum import Enum
+
+
+@dataclass(kw_only=True)
+class Endpoints:
+    root: str = "/sensorhub"
+    sos: str = f"{root}/sos"
+    connected_systems: str = f"{root}/api"
+
+
+@dataclass(kw_only=True)
+class Node(ABC):
+    address: str
+    port: int
+    endpoints: Endpoints
+    is_secure: bool
+
+
+class TemporalModes(Enum):
+    REAL_TIME = 0
+    ARCHIVE = 1
+    BATCH = 2
+    RT_SYNC = 3
+    ARCHIVE_SYNC = 4
+
+

oshconnect/datasource/__init__.py

@@ -0,0 +1,69 @@
+#  ==============================================================================
+#  Copyright (c) 2024. Botts Innovative Research, Inc.
+#  Date:  2024/5/15
+#  Author:  Ian Patterson
+#  Contact email:  ian@botts-inc.com
+#   ==============================================================================
+
+class OSHConnect:
+    datasource: DataSourceAPI
+    datastore: DataStoreAPI
+    styling: StylingAPI
+    timestream: TimeStreamAPI
+
+    def save_config(self, config: dict):
+        pass
+
+    def load_config(self, config: dict):
+        pass
+
+    def share_config(self, config: dict):
+        pass
+
+    def update_config(self, config: dict):
+        pass
+
+    def delete_config(self, config: dict):
+        pass
+
+    def configure_nodes(self, nodes: list):
+        pass
+
+    def filter_nodes(self, nodes: list):
+        pass
+
+    def task_system(self, task: dict):
+        pass
+
+    def select_temporal_mode(self, mode: str):
+        """
+        Select the temporal mode for the system. Real-time, archive, batch, as well as synchronization settings.
+        :param mode:
+        :return:
+        """
+        pass
+
+    def playback_streams(self, streams: list):
+        pass
+
+    def visualize_streams(self, streams: list):
+        pass
+
+    # Second Level Use Cases
+    def get_visualization_recommendations(self, streams: list):
+        pass
+
+    def discover_datastreams(self, streams: list):
+        pass
+
+    def discover_systems(self, systems: list):
+        pass
+
+    def discover_controlstreams(self, streams: list):
+        pass
+
+    def authenticate_user(self, user: dict):
+        pass
+
+    def synchronize_streams(self, systems: list):
+        pass

oshconnect/datastore/__init__.py

@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "oshconnect"
+version = "0.1.0"
+description = "Library for interfacing with OSH, helping guide visualization efforts, and providing a place to store configurations."
+authors = ["Ian Patterson <ian@botts-inc.com@gmail.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+consys4py = { git = "https://github.com/Botts-Innovative-Research/CSAPI4Py.git", branch = "dev" }
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"