dbay 0.1.0__tar.gz

dbay-0.1.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: dbay
+Version: 0.1.0
+Summary: A python library for interacting with the Device Bay VME racks. This library communicates with the local Device Bay webserver, which runs the user interface and keeps it in sync with changes made by this library
+Author-email: Andrew Mueller <andrewstermueller@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bkorzh/dbay
+Project-URL: Documentation, https://bkorzh.github.io/dbay/
+Keywords: dbay,client,api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: requests>=2.32.3
+
+# dbay-client/README.md
+
+# DBay Client
+
+DBay is a Python client for interacting with the DBay web server. This client allows you to manage and control various modules such as `dac4D` and `dac16D` through a simple interface.
+
+## Installation
+
+To install the DBay client, clone the repository and install the required dependencies:
+
+```bash
+git clone <repository-url>
+cd dbay-client
+pip install -e .
+```
+
+## Usage
+
+To use the DBay client, you need to create an instance of the `DBay` class with the server address (IP address and port). The client will automatically call the `/full-state` endpoint to retrieve the current state of the server.
+
+```python
+from src.client import DBay
+
+# Initialize the client with the server address
+client = DBay("0.0.0.0", port=8345)
+
+# Access the modules
+modules = client.modules
+```
+
+## Modules
+
+The client supports the following modules:
+
+- **dac4D**: Represents a DAC4D module and includes methods for controlling its functionality.
+- **dac16D**: Represents a DAC16D module and includes methods for controlling its functionality.
+- **Empty**: Represents an empty module.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.

dbay-0.1.0/README.md

@@ -0,0 +1,45 @@
+# dbay-client/README.md
+
+# DBay Client
+
+DBay is a Python client for interacting with the DBay web server. This client allows you to manage and control various modules such as `dac4D` and `dac16D` through a simple interface.
+
+## Installation
+
+To install the DBay client, clone the repository and install the required dependencies:
+
+```bash
+git clone <repository-url>
+cd dbay-client
+pip install -e .
+```
+
+## Usage
+
+To use the DBay client, you need to create an instance of the `DBay` class with the server address (IP address and port). The client will automatically call the `/full-state` endpoint to retrieve the current state of the server.
+
+```python
+from src.client import DBay
+
+# Initialize the client with the server address
+client = DBay("0.0.0.0", port=8345)
+
+# Access the modules
+modules = client.modules
+```
+
+## Modules
+
+The client supports the following modules:
+
+- **dac4D**: Represents a DAC4D module and includes methods for controlling its functionality.
+- **dac16D**: Represents a DAC16D module and includes methods for controlling its functionality.
+- **Empty**: Represents an empty module.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.

dbay-0.1.0/dbay/__init__.py

@@ -0,0 +1,2 @@
+# filepath: /Users/andrew/Documents/PROGRAM_LOCAL/dbay/software/backend/dbay-client/src/__init__.py
+# This file is intentionally left blank.

dbay-0.1.0/dbay/client.py

@@ -0,0 +1,35 @@
+from dbay.modules.dac4d import dac4D
+from dbay.modules.dac16d import dac16D
+from dbay.modules.empty import Empty
+from dbay.http import Http
+import time
+from typing import List, Union
+
+
+class DBay:
+    def __init__(self, server_address: str, port: int = 8345):
+        self.server_address = server_address
+        self.port = port
+        self.modules: List[Union[dac4D, dac16D, Empty]] = [None] * 8
+        self.http = Http(server_address, port)
+        self.load_full_state()
+
+    def load_full_state(self):
+        response = self.http.get("full-state")
+        self.instantiate_modules(response["data"])
+
+    def instantiate_modules(self, module_data: list):
+        for i, module_info in enumerate(module_data):
+            module_type = module_info["core"]["type"]
+            if module_type == "dac4D":
+                # print("info about dac4D class:"
+                self.modules[i] = dac4D(module_info, self.http)
+            elif module_type == "dac16D":
+                self.modules[i] = dac16D(module_info, self.http)
+            else:
+                self.modules[i] = Empty()
+
+    def get_modules(self):
+        return self.modules
+
+    # Additional methods to interact with the modules can be added here.

dbay-0.1.0/dbay/http.py

@@ -0,0 +1,23 @@
+import requests
+
+
+class Http:
+    def __init__(self, server_address: str, port: int):
+        self.server_address = server_address
+        self.port = port
+
+    def get(self, endpoint: str):
+        response = requests.get(f"http://{self.server_address}:{self.port}/{endpoint}")
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f"Failed to get data from {endpoint}")
+
+    def put(self, endpoint: str, data: dict):
+        response = requests.put(
+            f"http://{self.server_address}:{self.port}/{endpoint}", json=data
+        )
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f"Failed to put data to {endpoint}")

dbay-0.1.0/dbay/state.py

@@ -0,0 +1,17 @@
+from pydantic import BaseModel
+from typing import Literal
+
+
+class Core(BaseModel):
+    slot: int
+    type: str
+    name: str
+
+
+class IModule(BaseModel):
+    core: Core
+
+
+class Empty(IModule):
+    module_type: Literal["empty"] = "empty"
+    core: Core

dbay-0.1.0/dbay.egg-info/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: dbay
+Version: 0.1.0
+Summary: A python library for interacting with the Device Bay VME racks. This library communicates with the local Device Bay webserver, which runs the user interface and keeps it in sync with changes made by this library
+Author-email: Andrew Mueller <andrewstermueller@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bkorzh/dbay
+Project-URL: Documentation, https://bkorzh.github.io/dbay/
+Keywords: dbay,client,api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: requests>=2.32.3
+
+# dbay-client/README.md
+
+# DBay Client
+
+DBay is a Python client for interacting with the DBay web server. This client allows you to manage and control various modules such as `dac4D` and `dac16D` through a simple interface.
+
+## Installation
+
+To install the DBay client, clone the repository and install the required dependencies:
+
+```bash
+git clone <repository-url>
+cd dbay-client
+pip install -e .
+```
+
+## Usage
+
+To use the DBay client, you need to create an instance of the `DBay` class with the server address (IP address and port). The client will automatically call the `/full-state` endpoint to retrieve the current state of the server.
+
+```python
+from src.client import DBay
+
+# Initialize the client with the server address
+client = DBay("0.0.0.0", port=8345)
+
+# Access the modules
+modules = client.modules
+```
+
+## Modules
+
+The client supports the following modules:
+
+- **dac4D**: Represents a DAC4D module and includes methods for controlling its functionality.
+- **dac16D**: Represents a DAC16D module and includes methods for controlling its functionality.
+- **Empty**: Represents an empty module.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.

dbay-0.1.0/dbay.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+dbay/__init__.py
+dbay/client.py
+dbay/http.py
+dbay/state.py
+dbay.egg-info/PKG-INFO
+dbay.egg-info/SOURCES.txt
+dbay.egg-info/dependency_links.txt
+dbay.egg-info/requires.txt
+dbay.egg-info/top_level.txt

dbay-0.1.0/dbay.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dbay-0.1.0/dbay.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pydantic>=2.10.6
+requests>=2.32.3

dbay-0.1.0/dbay.egg-info/top_level.txt

@@ -0,0 +1 @@
+dbay

dbay-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "dbay"
+version = "0.1.0"
+description = "A python library for interacting with the Device Bay VME racks. This library communicates with the local Device Bay webserver, which runs the user interface and keeps it in sync with changes made by this library"
+
+
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "pydantic>=2.10.6",
+    "requests>=2.32.3",
+]
+authors = [
+    {name = "Andrew Mueller", email = "andrewstermueller@gmail.com"},
+]
+license = {text = "MIT"}
+keywords = ["dbay", "client", "api"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+]
+urls = {Homepage = "https://github.com/bkorzh/dbay", Documentation = "https://bkorzh.github.io/dbay/"}
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["dbay"]
+

dbay-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+