Merge pull request #134 from AD-SDL/dev

Workflow Parameters Support; Documentation Improvements

Author: LuckierDodge

.github/workflows/pre-commit.yml

@@ -9,7 +9,9 @@ jobs:
     steps:
     - uses: actions/checkout@v3
       name: Checkout code
-    - uses: actions/setup-python@v3
+    - uses: actions/setup-python@v4
       name: Setup Python
+      with:
+        python-version: 3.12
     - uses: pre-commit/[email protected]
       name: Run Pre-Commit Checks

.github/workflows/pypi-publish.yml

@@ -14,14 +14,14 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         name: Checkout code
-      - name: Set up Python 3.9
+      - name: Set up Python 3.12
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: 3.12
       - name: Setup PDM
         uses: pdm-project/setup-pdm@v3
         with:
-          python-version: 3.9
+          python-version: 3.12
       - name: Install dependencies
         run: pdm install
       - name: Publish to PyPi

.github/workflows/tests.yml

@@ -8,15 +8,13 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         name: Checkout code
-      - name: Set up Python 3.9
+      - name: Set up Python 3.12
         uses: actions/setup-python@v4
         with:
-          python-version: 3.9
+          python-version: 3.12
       - name: Setup PDM
         uses: pdm-project/setup-pdm@v3
         with:
-          python-version: 3.9
-      - name: Build the Project
-        run: make init build
+          python-version: 3.12
       - name: Test with pytest
-        run: make test
+        run: make init build test

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: check-json
@@ -17,7 +17,7 @@ repos:
       - id: nbstripout
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.6.5
+    rev: v0.7.0
     hooks:
       # Run the linter.
       - id: ruff

Dockerfile

@@ -32,7 +32,10 @@ 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
+    pip install -r wei/requirements/requirements.txt && \
+    pip install -r wei/requirements/dev.txt
+
+ENV PATH="${PATH}:~/.local/bin"
 
 # Copy rest of wei files
 COPY src wei/src

Makefile

@@ -14,6 +14,11 @@ else
 	@sed -i 's/^USER_ID=.*/USER_ID=$(shell id -u)/' .env
 	@sed -i 's/^GROUP_ID=.*/GROUP_ID=$(shell id -g)/' .env
 endif
+ifeq ($(OS),Windows_NT)
+	@where pdm || (Invoke-WebRequest -Uri https://pdm-project.org/install-pdm.py -UseBasicParsing).Content | py -
+else
+    @where pdm || curl -sSL https://pdm-project.org/install-pdm.py | python3 -
+endif
 
 
 .env: init
@@ -23,7 +28,7 @@ checks: # Runs all the pre-commit checks
 	@pre-commit run --all-files || { echo "Checking fixes\n" ; pre-commit run --all-files; }
 
 test: init .env build up # Runs all the tests
-	@docker compose run test_wei_server pytest -p no:cacheprovider wei
+	@docker compose exec test_wei_server pytest -p no:cacheprovider wei
 	@#docker compose down
 
 down:
@@ -52,7 +57,7 @@ build: build-python # Builds the project
 
 # (Make sure you've installed PDM)
 
-init-python: init pdm.lock deps # Installs the python environment (requires PDM)
+init-python: init pdm-update pdm.lock deps # Installs the python environment (requires PDM)
 
 build-python: init-python # Builds the pypi package for APP_NAME
 	pdm build
@@ -66,6 +71,9 @@ publish-python: init-python # Publishes the pypi package for wei
 # Python Dependency Managment #
 ###############################
 
+pdm-update:
+	pdm self update
+
 pdm.lock: pyproject.toml # Generates the pdm.lock file
 	pdm install --group :all
 

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

@@ -4,26 +4,9 @@ wei.config
 .. automodule:: wei.config
 
 
-   
-   
-
-   
-   
-   
-
-   
-   
    .. rubric:: Classes
 
    .. autosummary::
 
       Config
-   
-   
-
-   
-   
-   
-
-
-
+   

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

@@ -4,11 +4,6 @@ wei.core.admin
 .. automodule:: wei.core.admin
 
 
-   
-   
-
-   
-   
    .. rubric:: Functions
 
    .. autosummary::
@@ -22,16 +17,4 @@ wei.core.admin
       send_safety_stop
       send_shutdown
       send_unlock
-   
-   
-
-   
-   
-   
-
-   
-   
-   
-
-
-
+   

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

@@ -4,32 +4,15 @@ wei.core.events
 .. automodule:: wei.core.events
 
 
-   
-   
-
-   
-   
    .. rubric:: Functions
 
    .. autosummary::
 
       send_event
 
-   
-
-   
-   
    .. rubric:: Classes
 
    .. autosummary::
 
       EventHandler
-   
-   
-
-   
-   
-   
-
-
-
+   

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

@@ -4,28 +4,11 @@ wei.core.experiment
 .. automodule:: wei.core.experiment
 
 
-   
-   
-
-   
-   
    .. rubric:: Functions
 
    .. autosummary::
 
       get_experiment
       parse_experiments_from_disk
       register_new_experiment
-   
-   
-
-   
-   
-   
-
-   
-   
-   
-
-
-
+