Cleanup

Author: tginsbu1

.github/workflows/docker.yml

@@ -0,0 +1,71 @@
+name: Docker Image Build and Publish
+
+on:
+  push: # * Run for every push
+    branches: [ "*" ]
+    tags: [ '*' ]
+  schedule: # Run on Tuesday's at 12:00
+    - cron: '0 12 * * 2'
+  workflow_dispatch: # Run manually
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build_and_publish:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      # Login against a Docker registry
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=tag
+            type=ref,event=pr
+            type=raw,value=latest,enable={{is_default_branch}}
+
+      # Build and push Docker image with Buildx
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/pre-commit.yml

@@ -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

.justfile

@@ -0,0 +1,28 @@
+# List available commands
+default:
+  @just --list --justfile {{justfile()}}
+
+# initialize the project
+init:
+  @which pdm || echo "pdm not found, you'll need to install it: https://github.com/pdm-project/pdm"
+  @pdm install -G:all
+  @OSTYPE="" . .venv/bin/activate
+  @which pre-commit && pre-commit install && pre-commit autoupdate || true
+
+# Build the project
+build: init dcb
+
+# Run the pre-commit checks
+checks:
+  @pre-commit run --all-files || { echo "Checking fixes\n" ; pre-commit run --all-files; }
+check: checks
+
+# Run automated tests
+test:
+  @pytest
+tests: test
+pytest: test
+
+# Build docker image
+dcb:
+  @docker compose build

Dockerfile

@@ -1,4 +1,4 @@
-FROM madsci
+FROM ghcr.io/ad-sdl/madsci
 
 LABEL org.opencontainers.image.source=https://github.com/AD-SDL/hudson_platecrane_module
 LABEL org.opencontainers.image.description="Drivers and REST API's for the Hudson Platecrane and Sciclops robots"

README.md

@@ -1,2 +1,3 @@
 # sciclops_module
-A MADSci node module for interfacing with the Hudson Robotics Sciclops Platecrane
+
+A MADSci Node module for interfacing with the Hudson Robotics Sciclops Platecrane.

compose.yaml

@@ -2,19 +2,15 @@ name: sciclops_node
 services:
   sciclops:
     container_name: sciclops
-    image: sciclops
+    image: ghcr.io/ad-sdl/sciclops_module
     build:
       context: .
       dockerfile: Dockerfile
       tags:
-        - sciclops:latest
-        - sciclops:0.0.1
-        - sciclops:dev
+        - ghcr.io/ad-sdl/sciclops_module:latest
+        - ghcr.io/ad-sdl/sciclops_module:dev
     command: python -m sciclops_rest_node
     privileged: true
-    env_file: .env
+    network_mode: host
     volumes:
-      - /dev:/dev
-      - ./src:/home/app/sciclops_module/src
-    ports:
-      - 2000:2000
+      - ./definitions:/home/madsci/definitions

pyproject.toml

@@ -16,7 +16,7 @@ dependencies = [
     "pyusb",
     "libusb",
     "pyserial",
-    "madsci.node_module>=0.1.5",
+    "madsci.node_module>=0.1.9",
     "pydantic>=2.7",
     "pytest"
 ]