Merge pull request #1 from InformaticsMatters/updates

Updates

Author: alanbchristie

.github/workflows/build.yaml

@@ -26,6 +26,9 @@ on:
     tags-ignore:
     - '**'
 
+env:
+  POETRY_VERSION: 1.8.3
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -40,8 +43,11 @@ jobs:
         python-version: '3.10'
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install -r build-requirements.txt
+        python -m pip install --no-cache-dir poetry==${POETRY_VERSION}
+        POETRY_VIRTUALENVS_CREATE=false poetry install --only dev --no-root --no-directory
+    - name: Run pre-commit (all files)
+      run: |
+        pre-commit run --all-files
     - name: Login to DockerHub
       uses: docker/login-action@v3
       with:

.gitignore

@@ -2,3 +2,7 @@
 .idea
 data-manager/jote
 venv
+
+*~
+\#*#
+\#*

.mypy.ini

@@ -0,0 +1,7 @@
+[mypy]
+#ignore_missing_imports = True
+
+#[mypy-viewer.*]
+#disallow_untyped_defs = False
+#disallow_untyped_calls = False
+#check_untyped_defs = True

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+minimum_pre_commit_version: 3.6.0
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: check-case-conflict
+  - id: check-docstring-first
+  - id: check-executables-have-shebangs
+  - id: check-shebang-scripts-are-executable
+  - id: check-merge-conflict
+  - id: detect-private-key
+  - id: end-of-file-fixer
+  - id: check-toml
+  - id: check-yaml
+  - id: check-json
+  - id: trailing-whitespace
+    args:
+    - --markdown-linebreak-ext=md
+
+# isort
+- repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+  hooks:
+  - id: isort
+    args:
+    - --profile
+    - black
+    - --filter-files
+
+# Black
+- repo: https://github.com/psf/black
+  rev: 24.8.0
+  hooks:
+  - id: black
+    args:
+    - --target-version
+    - py311
+
+# MyPy
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.11.1
+  hooks:
+  - id: mypy
+
+# Pylint
+- repo: https://github.com/pycqa/pylint
+  rev: v3.2.6
+  hooks:
+  - id: pylint
+    args: [src,]

.pylintrc

@@ -0,0 +1,13 @@
+[messages control]
+
+# Disable some distracting checks.
+# See http://pylint.pycqa.org/en/latest/user_guide/message-control.html
+#
+# C : Convention warnings
+# R : Refactoring warnings
+disable = C, F, R,
+          bare-except,
+          broad-exception-caught,
+          broad-exception-raised,
+          fixme,
+          import-error,

DEVELOPER-README.md

@@ -11,10 +11,9 @@ ARM64 (Apple M1) processors, so we use Docker's [buildx] to build the image: -
         --tag informaticsmatters/data-manager-job-operator:latest
 
 ## Testing
-With the image built, use the Job tester utility: -
+With the image built, activate the environment: -
 
-    python -m pip install --upgrade pip
-    python -m pip install -r build-requirements.txt
+    poetry shell
 
 And, from the project root, run the tester: -
 

Dockerfile

@@ -1,10 +1,32 @@
-FROM python:3.11.5-alpine3.18
+FROM python:3.11.5-alpine3.18 as python-base
 
 ENV PYTHONUNBUFFERED=1
 ENV HOME=/code
 
-COPY requirements.txt /tmp/
-RUN pip install -r /tmp/requirements.txt
+
+# another stage for poetry installation. this ensures poetry won't end
+# up in final image where it's not needed
+FROM python-base AS poetry-base
+
+ARG POETRY_VERSION=1.8.3
+RUN pip install --no-cache-dir poetry==${POETRY_VERSION}
+
+WORKDIR /
+COPY poetry.lock pyproject.toml /
+
+RUN POETRY_VIRTUALENVS_IN_PROJECT=true poetry install --no-root --only main --no-directory
+
+
+
+# final stage. only copy the venv with installed packages and point
+# paths to it
+FROM python-base as final
+
+COPY --from=poetry-base /.venv /.venv
+
+ENV PYTHONPATH="${PYTHONPATH}:/.venv/lib/python3.11/site-packages/"
+ENV PATH=/.venv/bin:$PATH
+
 
 WORKDIR ${HOME}
 COPY src/ ./

README.md

@@ -33,14 +33,15 @@ From a fork you should be able to build and run the tests for the example
 Job that it defines, start with this, and you'll know you're starting with
 a working framework: -
 
-    python -m venv venv
-    source venv/bin/activate
-    python -m pip install -r build-requirements.txt
+    poetry shell
+    poetry install --no-root
+
+    pre-commit install -t commit-msg -t pre-commit
 
     docker-compose build
     jote
 
-    deactivate   
+    deactivate  
 
 > Note: You MUST provide at least one test for every Job your repository
 defines, and you MUST use our Job Tester ([im-jote]) to run those tests -