Cleanup as detailed in Issue #3

.gitignore

@@ -108,6 +108,7 @@ ipython_config.py
 #   in version control.
 #   https://pdm.fming.dev/#use-with-ide
 .pdm.toml
+.pdm-python
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
@@ -160,3 +161,6 @@ cython_debug/
 #.idea/
 
 .vscode
+
+# Madsci Folder
+.madsci

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v6.0.0
     hooks:
       - id: check-yaml
       - id: check-json
@@ -12,12 +12,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.7.1
+    rev: 0.9.1
     hooks:
       - id: nbstripout
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.3.0
+    rev: v0.15.12
     hooks:
       # Run the linter.
       - id: ruff

Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/ad-sdl/wei
+FROM ghcr.io/ad-sdl/madsci
 
 LABEL org.opencontainers.image.source=https://github.com/AD-SDL/mir_module
 LABEL org.opencontainers.image.description="Drivers and REST API's for the mir plate handler robots"
@@ -13,10 +13,10 @@ RUN mkdir -p mir_module
 COPY ./src mir_module/src
 COPY ./README.md mir_module/README.md
 COPY ./pyproject.toml mir_module/pyproject.toml
-COPY ./tests mir_module/tests
 
 RUN --mount=type=cache,target=/root/.cache \
-    pip install -e ./mir_module
+    uv pip install --python ${MADSCI_VENV}/bin/python -e /home/madsci/mir_module && \
+    chown -R ${USER_ID}:${GROUP_ID} /home/madsci/mir_module
 
 CMD ["python", "mir_module/src/mir_rest_node.py"]
 

README.md

@@ -3,21 +3,3 @@
 ## Overview
 
 The 'mir_module' repository is a comprehensive package that includes a MiR driver and REST node compatible with Mobile Industrial Robots (MiR) MiR 250 Base robot. This module is designed to provide a comprehensive and intuitive approach to controlling and interacting with a MiR 250. The repository allows for both immediate, simplified control of the MiR along with higher-level development of complex missions and experiments.
-
-## Features
-
-### MiR 250 Driver Package
-
-The MiR 250 driver package in this repository supports various methods to enable complete and comprehensive control of your MiR base robot and development of both simple and complex missions and environments. Key focuses and functions of the driver include:
-
-1. **Debugging and Development**
-    - Methods such as *get_actions* and *get_action_type* provide detailed information on the types of actions available to the MiR and the necessary parameters for continued development.
-
-2. **Mission Queue Configuration and Monitoring**
-    - Upon initialization of your MiR_Base robot, a new mission "session" is started. Functions related to mission queues will refer only to missions started during the session. The session can be reset after initialization as desired.
-
-3. **High-Level, Multi-Action Mission Development**
-
-4. **Simplified and Immediate MiR Control**
-
-... WIP