Merge pull request #129 from AD-SDL/dev

Improvements for Admin Actions, Datapoints, and Docs

Author: LuckierDodge

.github/workflows/docker-publish.yml

@@ -72,5 +72,5 @@ jobs:
           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
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
       - id: nbstripout
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.5.5
+    rev: v0.6.5
     hooks:
       # Run the linter.
       - id: ruff

Dockerfile

@@ -24,17 +24,16 @@ RUN mkdir -p wei/requirements
 RUN mkdir -p .wei/experiments
 RUN mkdir -p .diaspora
 
-# Install Python Dependencies first, for caching purposes
+# Install Node and Python Dependencies first, for caching purposes
+COPY ./src/ui/package*.json ./
+RUN npm install
+
 COPY requirements/requirements.txt wei/requirements/requirements.txt
 COPY requirements/dev.txt wei/requirements/dev.txt
 RUN --mount=type=cache,target=/root/.cache \
 	pip install --upgrade setuptools wheel pip && \
     pip install -r wei/requirements/requirements.txt
 
-# Install Node Dependencies first, for caching purposes
-COPY ./src/ui/package*.json ./
-RUN npm install
-
 # Copy rest of wei files
 COPY src wei/src
 COPY tests wei/tests

Makefile

@@ -3,7 +3,7 @@
 ################################################################################
 .DEFAULT_GOAL := init
 
-.PHONY: init checks test clean
+.PHONY: init checks test clean down up restart rebuild
 
 init: # Do the initial configuration of the project
 	@test -e .env || cp example.env .env
@@ -22,11 +22,20 @@ checks: # Runs all the pre-commit checks
 	@pre-commit install
 	@pre-commit run --all-files || { echo "Checking fixes\n" ; pre-commit run --all-files; }
 
-test: init .env build # Runs all the tests
-	@docker compose up -d
+test: init .env build up # Runs all the tests
 	@docker compose run test_wei_server pytest -p no:cacheprovider wei
 	@#docker compose down
 
+down:
+	@docker compose down
+
+up:
+	@docker compose up -d --remove-orphans
+
+restart: build up
+
+rebuild: restart
+
 clean:
 	@rm .env
 

compose.yaml

@@ -63,6 +63,14 @@ services:
       --save 600 1
       --loglevel warning
       --appendonly yes'
+  utilities:
+    image: ${IMAGE}
+    container_name: utilities
+    ports:
+      - 8001:8001
+    command: 'python3 -m wei.modules.utility_module
+      --port 8001
+      --alias utilities'
 
 ################
 # Data Storage #

docs/source/assets/dashboard.png

@@ -13,12 +13,15 @@ wei.core.admin
 
    .. autosummary::
 
+      check_can_send_admin_command
       send_cancel
+      send_lock
       send_pause
       send_reset
       send_resume
       send_safety_stop
       send_shutdown
+      send_unlock
 
 
 

docs/source/pages/_autosummary/wei.core.admin.rst

@@ -0,0 +1,30 @@
+wei.core.notifications
+======================
+
+.. automodule:: wei.core.notifications
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      send_email
+      send_failed_step_notification
+   
+   
+
+   
+   
+   
+
+   
+   
+   
+
+
+

docs/source/pages/_autosummary/wei.core.notifications.rst

@@ -34,6 +34,7 @@ wei.core
    wei.core.location
    wei.core.loggers
    wei.core.module
+   wei.core.notifications
    wei.core.scheduler
    wei.core.state_manager
    wei.core.step

docs/source/pages/_autosummary/wei.core.rst

@@ -28,4 +28,5 @@ wei.modules
    :recursive:
 
    wei.modules.rest_module
+   wei.modules.utility_module