Merge branch 'main' into pre-commit

* main:
  ⬛ 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/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,21 @@
+name: 🧪 Integration Tests
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  tests:
+    name: ⚗️ Application Tests
+    uses: WGBH-MLA/.github/.github/workflows/pytest-with-postgres.yml@main
+    secrets: inherit
+    with:
+      pdm_args: -G test,ci
+      pytest_args: -n auto --nbmake -ra -s
+      pg_db: ov-test
+
+  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/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

.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
+}

dev.yml

@@ -8,9 +8,8 @@ services:
       - db
     environment:
       OV_DB_HOST: db
-    #   OV_DB_PASSWORD:
     env_file:
       - .env
   db:
     env_file:
-      - .db
+      - .env

docker-compose.yml

@@ -5,7 +5,8 @@ services:
     build:
       context: .
       target: base
-    image: ov-wag
+    # Use the `image` property to run a prebuilt image from GHCR instead of building locally. Requires disabling the `build` section above.
+    # image: ghcr.io/wgbh-mla/ov-wag:main
     volumes:
       - ./:/app/
     entrypoint: /app/docker_entrypoints/dev.sh
@@ -15,20 +16,17 @@ services:
         delay: 5s
         max_attempts: 3
         window: 5s
-  wagtail-tests:
-    build:
-      context: .
-      target: test
-    image: ov-tests
-    volumes:
-      - ./:/app/
-    entrypoint: /app/docker_entrypoints/test.sh
-    environment:
-      - OV_DB_ENGINE=django.db.backends.sqlite3
-      - OV_DB_NAME=testdb
   db:
-    image: postgres:14.2-alpine
-    volumes:
-      - ./db:/var/lib/postgresql/data:Z
-    user: ${UID}:${GID}
+    image: postgres:16-alpine
     restart: always
+    ports:
+      - 5432:5432
+    environment:
+      - POSTGRES_DB=${OV_DB_NAME}
+      - POSTGRES_USER=${OV_DB_USER}
+      - POSTGRES_PASSWORD=${OV_DB_PASSWORD}
+    volumes:
+      - db:/var/lib/postgresql/data
+
+volumes:
+  db:

exhibits/management/commands/rename.py

@@ -21,9 +21,20 @@ def handle(self, old_name, new_name, models, *args, **options):
             # Rename model
             old_name = old_name[0]
             new_name = new_name[0]
-            cursor.execute("UPDATE django_content_type SET app_label='{}' WHERE app_label='{}'".format(new_name, old_name))
-            cursor.execute("UPDATE django_migrations SET app='{}' WHERE app='{}'".format(new_name, old_name))
+            cursor.execute(
+                "UPDATE django_content_type SET app_label='{}' WHERE app_label='{}'".format(
+                    new_name, old_name
+                )
+            )
+            cursor.execute(
+                "UPDATE django_migrations SET app='{}' WHERE app='{}'".format(
+                    new_name, old_name
+                )
+            )
 
             for model in models:
-                cursor.execute("ALTER TABLE {old_name}_{model_name} RENAME TO {new_name}_{model_name}".format(
-                    old_name=old_name, new_name=new_name, model_name=model))
+                cursor.execute(
+                    "ALTER TABLE {old_name}_{model_name} RENAME TO {new_name}_{model_name}".format(
+                        old_name=old_name, new_name=new_name, model_name=model
+                    )
+                )

exhibits/models.py

@@ -85,17 +85,20 @@ class ExhibitPage(Page):
     ]
 
     content_panels = Page.content_panels + [
-        MultiFieldPanel([
-            FieldPanel('cover_image'),
-            FieldPanel('hero_image'),
-        ], heading='Images'),
+        MultiFieldPanel(
+            [
+                FieldPanel('cover_image'),
+                FieldPanel('hero_image'),
+            ],
+            heading='Images',
+        ),
         FieldPanel('body', classname='collapsed'),
         InlinePanel('authors', heading='Author(s)'),
         InlinePanel(
-                    'other_exhibits',
-                    heading='Other Exhibits',
-                    max_num=3,
-                )
+            'other_exhibits',
+            heading='Other Exhibits',
+            max_num=3,
+        ),
     ]
 
     api_fields = [

exhibits/tests/factories.py

@@ -4,7 +4,6 @@
 
 
 class ExhibitPageFactory(PageFactory):
-
     cover_image = SubFactory(ImageChooserBlockFactory)
     hero_image = SubFactory(ImageChooserBlockFactory)
     # other_exhibits =

exhibits/tests/test_exhibit_page.py

@@ -2,6 +2,7 @@
 from ..models import ExhibitPage
 from .factories import ExhibitPageFactory
 
+
 # Create your tests here.
 class ExhibitPageTests(TestCase):
     def test_exhibit_page_factory(self):

home/models.py

@@ -5,13 +5,12 @@
 from wagtail.admin.edit_handlers import FieldPanel
 from wagtail.api import APIField
 
+
 class HomePage(Page):
     body = RichTextField(blank=True)
 
     content_panels = Page.content_panels + [
         FieldPanel('body', classname="full"),
     ]
 
-    api_fields = [
-        APIField('body')
-    ]
+    api_fields = [APIField('body')]

manage.py

@@ -2,6 +2,11 @@
 import os
 import sys
 
+from dotenv import load_dotenv
+
+# take environment variables from .env.
+load_dotenv()
+
 if __name__ == "__main__":
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ov_wag.settings.dev")