Module-ify and add some type hinting; move to async sqlite3 lib

.dockerignore

@@ -1,4 +1,6 @@
-config/config.ini
+canary/config/config.ini
+data/runtime/*.db
+data/runtime/*.obj
 env/
 tests/
 venv/

.github/workflows/formatting_check.yml

@@ -3,15 +3,14 @@ name: formatting check
 on:
   push:
     paths:
-      "**.py"
+      - "**.py"
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
       - uses: psf/black@stable
         with:
-          options: "--diff --check -t py310 --fast"
-
+          options: "--diff --check -t py311 canary"

.github/workflows/poetry-dev.yml

@@ -24,18 +24,16 @@ jobs:
     strategy:
       matrix:
         os:
-          - 'ubuntu-20.04'
-          - 'ubuntu-18.04'
-          # - 'macos-10.15'
-          - 'macos-11.0'
-          - 'windows-2019'
+          - 'ubuntu-24.04'
+          - 'macos-14.0'
+          - 'windows-2022'
         python-version:
-          - '3.10'
+          - '3.11'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -50,4 +48,3 @@ jobs:
 
       - name: install canary development dependencies
         run: poetry install --no-interaction
-

.github/workflows/poetry-prod.yml

@@ -17,15 +17,14 @@ jobs:
     strategy:
       matrix:
         os:
-          - 'ubuntu-20.04'
-          - 'ubuntu-18.04'
+          - 'ubuntu-24.04'
         python-version:
-          - '3.10'
+          - '3.11'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -40,4 +39,3 @@ jobs:
 
       - name: install canary production dependencies
         run: poetry install --no-dev --no-interaction
-

.github/workflows/publish-docker.yml

@@ -4,34 +4,64 @@ on:
   release:
     types: [published]
 
+  push:
+    branches:
+      - master
+
 jobs:
   publish:
     runs-on: ubuntu-latest
     permissions:
       packages: write
       contents: read
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+
+      - name: Set up master (edge) image metadata
+        id: meta-master
+        uses: docker/metadata-action@v5
+        if: ${{ github.event_name != 'release' }}
         with:
-          python-version: '3.10'
-      - run: pip install poetry && poetry update && poetry export -f requirements.txt > requirements.txt
-      - uses: docker/metadata-action@v3
-        id: meta
+          images: |
+            ${{ inputs.image-name }}
+          flavor: |
+            latest=false
+          tags: |
+            type=raw,value=master,enable={{is_default_branch}}
+            type=sha,prefix=sha-
+
+      - name: Set up release image metadata
+        id: meta-release
+        uses: docker/metadata-action@v5
+        if: ${{ github.event_name == 'release' }}
         with:
           images: ghcr.io/idoneam/Canary
+          flavor: |
+            latest=true
           tags: |
             type=semver,pattern={{major}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{version}}
-      - uses: docker/setup-buildx-action@v1
-      - uses: docker/login-action@v1
+
+      - uses: docker/setup-buildx-action@v3
+
+      - uses: docker/login-action@v3
         with:
           registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ github.token }}
-      - uses: docker/build-push-action@v2
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push master (edge) image
+        uses: docker/build-push-action@v6
+        if: ${{ github.event_name != 'release' }}
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta-master.outputs.tags }}
+
+      - uses: docker/build-push-action@v6
+        if: ${{ github.event_name == 'release' }}
         with:
           context: .
           push: true
-          tags: ${{ steps.meta.outputs.tags }}
+          tags: ${{ steps.meta-release.outputs.tags }}

.gitignore

@@ -103,6 +103,7 @@ ENV/
 
 # configuration files
 **/*.ini
+poetry.toml
 
 # other
 *~

Dockerfile

@@ -1,28 +1,38 @@
-FROM python:3.10-slim-bullseye
+FROM python:3.11-slim-bookworm
 
-# Install base apt dependencies
-RUN apt-get update && apt-get install -y git sqlite3
+# Install base apt dependencies + auxiliary dependencies (for GL, Tex, etc.)
+RUN apt-get update && \
+    apt-get install -y  \
+      git \
+      sqlite3 \
+      libgl1-mesa-glx \
+      texlive-latex-extra \
+      texlive-fonts-extra \
+      texlive-lang-greek \
+      dvipng \
+      ffmpeg \
+      gcc && \
+    rm -rf /var/lib/apt/lists/*
 
-# Install auxiliary dependencies (for GL, Tex, etc.)
-RUN apt-get install -y \
-  libgl1-mesa-glx \
-  texlive-latex-extra \
-  texlive-fonts-extra \
-  texlive-lang-greek \
-  dvipng \
-  ffmpeg \
-  gcc
+# Update pip, install poetry
+RUN pip install --no-cache-dir -U pip; \
+    pip install --no-cache-dir poetry==1.8.3
 
-# Install requirements with pip to use Docker cache independent of project metadata
-COPY requirements.txt /
-RUN pip install -r /requirements.txt
+COPY pyproject.toml .
+COPY poetry.lock .
+RUN poetry config virtualenvs.create false && \
+    poetry --no-cache install --no-root --without dev
 
-# Copy code to the `canary` directory in the image and run the bot from there
-COPY . /canary
-WORKDIR /canary
+# Copy code and pre-made data to the /app directory, where the bot will be run from
+WORKDIR /app
+COPY canary canary
+COPY data data
+
+RUN pip install -e .
 
 # Notes:
-#   Users will have to mount their config.ini in by hand
-#   Users should mount a read/writable volume for /canary/data/runtime
+#   Users will have to configure their instance using environment variables, described by the Pydantic settings object
+#     in /app/canary/config/config.py
+#   Users should mount a read/writable volume for /app/data/runtime
 
-CMD ["python3.10", "Main.py"]
+CMD ["canary"]

MANIFEST.in

@@ -0,0 +1 @@
+include canary/Martlet.schema