Refactor ojd_daps_skills

.github/workflows/docs.yml

@@ -0,0 +1,33 @@
+name: Deploy docs to gh-pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - dev
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Deploy docs to gh-pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      # - name: Install dependencies
+      #   run: |
+      #     $CONDA/bin/python -m pip install --upgrade pip
+      #     $CONDA/bin/python -m pip install mkdocs-material
+
+      - name: Deploy
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: mkdocs.yml
+          REQUIREMENTS: requirements.txt

.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+name: Linting
+
+on:
+  push:
+
+jobs:
+  linting-python:
+    name: Lint Python
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install Dependencies
+        shell: bash
+        run: |
+          pip install ruff black isort
+
+      - name: Run ruff
+        if: always()
+        shell: bash
+        run: python -m ruff check ojd_daps_skills tests
+
+      - name: Run black
+        if: always()
+        shell: bash
+        run: black --check ojd_daps_skills tests

.github/workflows/pytest.yml.example

@@ -0,0 +1,58 @@
+name: Unit Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "macos-latest"]
+        python-version: ["3.9", "3.10"]
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      #----------------------------------------------
+      #       load cached venv if cache exists
+      #----------------------------------------------
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      #----------------------------------------------
+      # install dependencies if cache does not exist
+      #----------------------------------------------
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+      #----------------------------------------------
+      # install your root project, if required
+      #----------------------------------------------
+      - name: Install additional dependencies
+        run: |
+          poetry install --no-interaction
+          poetry run python -m spacy download en_core_web_sm
+      #----------------------------------------------
+      #    add matrix specifics and run test suite
+      #----------------------------------------------
+      - name: Run tests
+        run: poetry run pytest tests/ --verbose

.gitignore

@@ -3,6 +3,11 @@
 
 *.lock
 
+#ignore data files
+__MACOSX/
+ojd_daps_skills_data/
+ojd_daps_skills_models/
+
 # Proposed convention
 scratch*
 

.pre-commit-config.yaml

@@ -7,54 +7,7 @@ repos:
         language: system
         types: [python]
         require_serial: true
-      - id: check-added-large-files
-        name: Check for added large files
-        entry: check-added-large-files
-        language: system
-      - id: check-merge-conflict
-        name: Check for files with merge conflict strings
-        entry: check-merge-conflict
-        language: system
-      - id: end-of-file-fixer
-        name: Fix End of Files
-        entry: end-of-file-fixer
-        language: system
-        types: [text]
-        stages: [commit, push, manual]
-      - id: trailing-whitespace
-        name: Trim Trailing Whitespace
-        entry: trailing-whitespace-fixer
-        language: system
-        types: [text]
-        stages: [commit, push, manual]
-      - id: check-toml
-        name: Check Toml
-        entry: check-toml
-        language: system
-        types: [toml]
-      - id: check-yaml
-        name: Check Yaml
-        entry: check-yaml
-        language: system
-        types: [yaml]
-      # - id: reorder-python-imports
-      #   name: Reorder python imports
-      #   entry: reorder-python-imports
-      #   language: system
-      #   types: [python]
-      # - id: flake8
-      #   name: flake8
-      #   entry: flake8
-      #   language: system
-      #   types: [python]
-      #   args: ["--config=.flake8"]
-      #   require_serial: true
-      - id: no-commit-to-branch
-        name: Prevent commits to dev / master
-        entry: no-commit-to-branch
-        language: python
-        args: ["-b", dev, "-b", master, "-b", main]
-        pass_filenames: false
+
   - repo: https://github.com/prettier/pre-commit
     rev: v2.1.2
     hooks: