Merge branch 'main' into docs

* main:
  👊 Version bump v0.4.0
  🐩 Upgrade Wagtail (#98)
  🔄 Sync labels
  🏷 Labels (#100)
  🛡 GGShield (#96)
  💻 CLI (#83)
  🧫 Pytest (#97)
  👖 Lint (#94)
  ⬛ Black (#93)
  🕸 VSCode Debugger (#85)
  🎬 Workflow Actions (#76)

.env.example

@@ -0,0 +1,6 @@
+OV_DB_ENGINE=django.db.backends.postgresql
+OV_DB_HOST=0.0.0.0
+OV_DB_PORT=5432
+OV_DB_NAME=postgres
+OV_DB_USER=postgres
+OV_DB_PASSWORD=""

.github/release.yml

@@ -2,21 +2,30 @@ changelog:
   categories:
     - title: Breaking Changes 🪅
       labels:
-        - 'breaking 💔'
+        - breaking 💔
 
     - title: New Features 🎉
       labels:
-        - 'enhancement ➕'
+        - enhancement ➕
 
-    - title: 'Bugfixes 🐛'
+    - title: Bugfixes 🐛
       labels:
-        - 'bug 🐛'
+        - bug 🐛
 
-    - title: 'Maintenance 🔩'
+    - title: Deployment 🚀
       labels:
-        - 'maintenance 🔧'
-        - 'CI 🦾'
-        - 'CD 🏗️'
+        - production 🎭
+        - dev 💻
+
+    - title: Maintenance 🔩
+      labels:
+        - maintenance 🔧
+        - CI 🦾
+        - CD 🏗️
+
+    - title: Documentation 📚
+      labels:
+        - documentation 📜
 
     - title: Other Changes
       labels:

.github/workflows/CD.yml

@@ -0,0 +1,19 @@
+name: 🪂 Deploy
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types: [published, edited, prereleased]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: 🔨 Build and deploy docker image
+    uses: WGBH-MLA/.github/.github/workflows/build.yml@main
+    with:
+      target: production

.github/workflows/CI.yml

@@ -0,0 +1,20 @@
+name: 🧪 Integration Tests
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  tests:
+    name: ⚗️ App Tests
+    uses: WGBH-MLA/.github/.github/workflows/pytest-with-postgres.yml@main
+    secrets: inherit
+    with:
+      pdm_args: -G test
+      pytest_args: -n auto --nbmake -ra -s
+      pg_db: ov
+  lint:
+    name: 👕 Lint
+    uses: WGBH-MLA/.github/.github/workflows/lint.yml@main
+
+  black:
+    name: 🖤 Black
+    uses: WGBH-MLA/.github/.github/workflows/black.yml@main

.github/workflows/labels.yml

@@ -0,0 +1,12 @@
+name: 🏷 Sync labels
+on:
+  workflow_dispatch:
+
+permissions:
+  issues: write
+
+jobs:
+  labels:
+      name: 🔄 Sync labels
+      uses: WGBH-MLA/.github/.github/workflows/labels.yml@main
+

.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: 🏛 Publish to PyPi
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    name: 📦 Build package
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📰 Checkout
+        uses: actions/checkout@v3
+
+      - name: 📲 Setup PDM
+        uses: pdm-project/setup-pdm@v3
+        id: setup-python
+        with:
+          python-version: 3.x
+
+      - name: 🚚 Install dependencies
+        run: pdm install --prod
+
+      - name: 🏗️ Build package
+        run: pdm build
+
+      - name: 🛫 Export build files
+        uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist
+
+  publish:
+    name: 🗞 Publish package
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: 🛬 Download artifacts
+        uses: actions/download-artifact@v3
+
+      - name: 🗞 Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/release.yml

@@ -0,0 +1,11 @@
+name: 📦 Release
+
+on:
+  milestone:
+    types: [closed]
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: 📝 Draft Release
+    uses: WGBH-MLA/.github/.github/workflows/draft_release.yml@main

.github/workflows/update.yml

@@ -0,0 +1,12 @@
+name: 🛍 Update dependencies
+# On Wednesdays, we update our dependencies.
+
+on:
+  schedule:
+    - cron: 0 12 * * 3
+  workflow_dispatch:
+
+jobs:
+  update:
+    name: 🦿 Update dependencies
+    uses: WGBH-MLA/.github/.github/workflows/update.yml@main

.gitignore

@@ -15,11 +15,15 @@
 __pycache__
 *.pyc
 .DS_Store
-/venv/
 
-# Database
-db/
+# Virtual environment
+.venv
 
-# Environment files
+# Environment variable files
 .env
-.db
+!.env.example
+
+# VS Code
+.vscode/
+!.vscode/settings.json
+!.vscode/launch.json

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/gitguardian/ggshield
+    rev: v1.20.0
+    hooks:
+      - id: ggshield
+        language_version: python3
+        stages: [commit]

.vscode/launch.json

@@ -0,0 +1,64 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "inputs": [
+        {
+            "id": "numWorkers",
+            "type": "promptString",
+            "default": "4",
+            "description": "Number of Gunicorn workers to run"
+        }
+    ],
+    "configurations": [
+        {
+            "name": "OV Wagtail - Django dev server",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/manage.py",
+            "args": [
+                "runserver",
+                "0.0.0.0:8000"
+            ],
+            "django": true,
+            "justMyCode": false
+        },
+        {
+            "name": "OV Wagtail - Gunicorn",
+            "type": "python",
+            "request": "launch",
+            "program": "gunicorn",
+            "args": [
+                "-w ${input:numWorkers}",
+                "-b 0.0.0.0:4000",
+                "ov-wag.wsgi:applications",
+            ],
+            "django": true,
+            "justMyCode": false
+        },
+        {
+            "name": "Run Migrations",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/manage.py",
+            "args": [
+                "migrate",
+                "--noinput"
+            ],
+            "django": true,
+            "justMyCode": false
+        },
+        {
+            "name": "Run Tests",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/manage.py",
+            "args": [
+                "test",
+            ],
+            "django": true,
+            "justMyCode": false
+        },
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "-v",
+    ],
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false
+}

Dockerfile

@@ -1,5 +1,8 @@
 # Use an official Python runtime based on Debian 10 "buster" as a parent image.
-FROM python:3.10-slim-buster as base
+FROM python:3.11-slim as base
+
+WORKDIR /app
+COPY docker_entrypoints /docker_entrypoints
 
 # Install system packages required by Wagtail and Django.
 RUN apt-get update --yes --quiet && apt-get install --yes --quiet --no-install-recommends \
@@ -8,19 +11,25 @@ RUN apt-get update --yes --quiet && apt-get install --yes --quiet --no-install-r
     libjpeg62-turbo-dev \
     zlib1g-dev \
     libwebp-dev \
- && rm -rf /var/lib/apt/lists/*
-
-# Install the project requirements.
-COPY requirements.txt /
-RUN pip install -r /requirements.txt
+    && rm -rf /var/lib/apt/lists/*
 
-WORKDIR /app
+COPY pyproject.toml pdm.lock README.md ./
+COPY ov_wag ov_wag
+COPY authors authors
+COPY exhibits exhibits
+COPY ov_collections ov_collections
+COPY search search
 
+### Test ###
 # Build the test image, which includes the test applications
 FROM base as test
-COPY requirements-test.txt /
-RUN pip install -r /requirements-test.txt
+# Install the test requirements.
+RUN pip install pdm
+RUN pdm install -dG test
+
+ENTRYPOINT /docker_entrypoints/test.sh
 
+### Production ###
 # Build the production image, with the application server
 FROM base as production
 
@@ -37,8 +46,6 @@ ENV PYTHONUNBUFFERED=1 \
 EXPOSE 80
 
 # Install the application server.
-RUN pip install "gunicorn>=20.1.0,<20.2.0"
-
-COPY . .
+RUN pip install .[production]
 
-ENTRYPOINT /app/docker_entrypoints/deploy.sh
+ENTRYPOINT /docker_entrypoints/deploy.sh