Upgrade to MADSci 0.8

.github/workflows/pre-commit.yaml

@@ -0,0 +1,20 @@
+name: Pre-Commit Checks
+
+on:
+  push: # Run for every push
+    branches: ["*"]
+    tags: ["*"]
+  workflow_dispatch: # Run manually
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      name: Checkout code
+    - uses: actions/setup-python@v4
+      name: Setup Python
+      with:
+        python-version: 3.9
+    - uses: pre-commit/action@v3.0.1
+      name: Run Pre-Commit Checks

.gitignore

@@ -560,3 +560,5 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
+# MADSci runtime state (logs, ID registry) — per-machine, not shared
+.madsci/

.pre-commit-config.yaml

@@ -1,9 +1,8 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.0
     hooks:
       - id: check-yaml
-      - id: check-json
       - id: check-toml
       - id: check-ast
       - id: check-merge-conflict
@@ -12,15 +11,19 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.7.1
+    rev: 0.8.1
     hooks:
       - id: nbstripout
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.5.7
+    rev: v0.14.5
     hooks:
       # Run the linter.
       - id: ruff
         args: [--fix]
       # Run the formatter.
       - id: ruff-format
+  - repo: https://gitlab.com/bmares/check-json5
+    rev: v1.0.0
+    hooks:
+    - id: check-json5

LICENSE

@@ -13,8 +13,8 @@ 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
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHidexServiceNTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHidexServiceLL 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

README.md

@@ -2,14 +2,39 @@
 
 Contains `hidex_node`, providing an interface and adapter that works alongside the Hidex Plate Reader's first party driver to control the instrument.
 
-## Installation Notes
+## Building the C# Solution
 
-To make the server accessible, run the following in a terminal as Administrator
+To use this interface, you must first open `src/hidex_interface/HidexInterface.sln` and build the solution.
 
-```
-netsh http add urlacl url=http://+:2005/ user=<USER> listen=yes delegate=yes
-```
+## Python Installation/Usage
 
-Replace `2005` with the port you intend to use, if it differs from the default, and `<USER>` with the username that will be running the server (you may need to use the form `DOMAIN/USER`)
+This package is Windows-only.
 
-To interface with the module from another device, you'll need to [open up the port](https://www.windowscentral.com/how-open-port-windows-firewall) you intend to run the module's server on (2005 by default). 
+### Using virtualenv
+
+1. Open Command Prompt and navigate to the project directory.
+2. Create a virtual environment:
+   ```
+   python -m venv venv
+   ```
+3. Activate the virtual environment:
+   ```
+   venv\Scripts\activate
+   ```
+4. Install the package and dependencies:
+   ```
+   pip install -r requirements.txt
+   ```
+
+### Using pdm
+
+1. Install PDM if you don't have it: https://pdm-project.org/latest/#installation
+2. Navigate to the project directory.
+3. Install dependencies:
+   ```
+   pdm install
+   ```
+4. To start the node:
+   ```
+   pdm run python src/hidex_rest_node.py
+   ```