Release v2.1.0

.dockerignore

@@ -0,0 +1,17 @@
+.git
+__pycache__
+*.pyc
+*.pyo
+.venv
+.env
+*.sqlite3
+.github
+.gitignore
+README.md
+CONTRIBUTING.md
+CODE_OF_CONDUCT.md
+LICENSE
+*.md
+.pytest_cache
+.ruff_cache
+node_modules

.env.example

@@ -0,0 +1,5 @@
+OPEN5E_DEBUG=True
+SECRET_KEY=replace-me-with-a-random-secret-key
+SERVER_NAME=localhost
+CERTFILE=selfsigned.crt
+KEYFILE=selfsigned.key

.github/workflows/build_and_deploy.yml

@@ -4,31 +4,49 @@ on:
     branches:
       - staging
       - main
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+      - 'scripts/**'
+      - '.github/ISSUE_TEMPLATE/**'
+
+concurrency:
+  group: deploy-${{ github.ref_name }}
+  cancel-in-progress: true
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v6
       - name: Login to Docker Hub
+        if: github.ref == 'refs/heads/main'
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Set Docker image tag
-        run: | 
+      - name: Login to GHCR
+        if: github.ref == 'refs/heads/staging'
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Set image tags
+        run: |
           echo "GITHUB_REF = $GITHUB_REF" > version.py
           echo "GITHUB_SHA = $GITHUB_SHA" >> version.py
-        
+
           if [[ $GITHUB_REF == refs/heads/main ]]; then
-            echo "DOCKER_IMAGE_TAG=latest" >> $GITHUB_ENV
+            echo "IMAGE_TAGS=eepmoody/open5e-api:latest" >> $GITHUB_ENV
           elif [[ $GITHUB_REF == refs/heads/staging ]]; then
-            echo "DOCKER_IMAGE_TAG=staging" >> $GITHUB_ENV
+            echo "IMAGE_TAGS=ghcr.io/open5e/open5e-api:beta" >> $GITHUB_ENV
           fi
       - name: Build and push
         uses: docker/build-push-action@v7
         with:
           push: true
-          tags: eepmoody/open5e-api:${{ env.DOCKER_IMAGE_TAG }}
+          tags: ${{ env.IMAGE_TAGS }}
 
   deploy:
     runs-on: ubuntu-latest

.github/workflows/clear_cache.yml

@@ -1,7 +1,10 @@
 name: Clear Cloudflare Cache After Deployments
 
 on:
-  push:
+  workflow_run:
+    workflows: ["Build and deploy"]
+    types:
+      - completed
     branches:
       - main
       - staging

.github/workflows/pr_validation.yml

@@ -12,28 +12,32 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11'
-          cache: pipenv
-      - name: Install Pipenv
-        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
-      - name: Install Dependencies
-        run: pipenv install --dev
+          enable-cache: true
+          prune-cache: false
+      - name: Install Python
+        run: uv python install 3.11
+      - name: Install dependencies
+        run: uv sync
+      - name: Check migrations are up to date
+        run: uv run python manage.py makemigrations --check --dry-run
       - name: Run migrations
-        run: pipenv run python manage.py quicksetup --noindex
+        run: uv run python manage.py quicksetup --noindex
       - name: Run Tests
         run: |
-          pipenv run python manage.py runserver 0.0.0.0:8000 &
+          uv run python manage.py runserver 0.0.0.0:8000 &
           sleep 5 &&
-          pipenv run pytest
+          uv run pytest
       - name: Validate Data
         run: |
-          pipenv run python ./scripts/data_test.py --dir ./data/v2 &
-          pipenv run python ./manage.py 
+          uv run python ./scripts/data_test.py --dir ./data/v2 &
+          uv run python ./manage.py
   build:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v6
       - name: Sanitize branch name
         run: echo "BRANCH_NAME=$(echo ${GITHUB_REF##*/} | tr '/' '-')" >> $GITHUB_ENV
       - name: Build Docker image

.gitignore

@@ -1,4 +1,5 @@
 # Environment and configuration files
+.env
 local.env
 *.local
 .python-version
@@ -36,3 +37,5 @@ server/vector_index.pkl
 
 # Temporary files for magic items update
 temp_magic_items/
+references_report.json
+sources_report.json

AGENTS.md

@@ -1,6 +1,6 @@
 This is a project that encodes 5th Edition Dungeons and Dragons rules into an API.
 
-To ingest data, it is best to run `manage.py quicksetup` from within the pipenv environment. You can check the readme.md for additional instructions about using this repo.
+To ingest data, it is best to run `uv run python manage.py quicksetup` from the project root. You can check the readme.md for additional instructions about using this repo.
 
 Before calling a task finished, always run scripts like `quicksetup` and tests, plus any other reasonable checks, to ensure that data can correctly be ingested and your changes work.
 

Dockerfile

@@ -1,20 +1,35 @@
-FROM python:3.11-slim
+FROM ghcr.io/astral-sh/uv:python3.11-bookworm-slim AS builder
 
-RUN mkdir -p /opt/services/open5e-api
 WORKDIR /opt/services/open5e-api
-# copy our project code
 
-# install our dependencies
-RUN pip install pipenv gunicorn
-COPY . /opt/services/open5e-api
+ENV UV_LINK_MODE=copy \
+    UV_PYTHON_DOWNLOADS=never \
+    UV_COMPILE_BYTECODE=1
 
-RUN pipenv install
+COPY pyproject.toml uv.lock ./
+RUN uv sync --frozen --no-dev --no-install-project
 
-# migrate the db, load content, and index it
-RUN pipenv run python manage.py quicksetup
+COPY . .
+RUN uv run python manage.py quicksetup
+RUN uv run python -m gunicorn --version
 
-# remove .env file (set your env vars via docker-compose.yml or your hosting provider)
-RUN rm .env
+FROM python:3.11-slim-bookworm
 
-#run gunicorn.
-CMD ["pipenv", "run", "gunicorn","-b", ":8888", "server.wsgi:application"]
+WORKDIR /opt/services/open5e-api
+
+COPY --from=builder /opt/services/open5e-api/.venv ./.venv
+COPY --from=builder /opt/services/open5e-api/server ./server
+COPY --from=builder /opt/services/open5e-api/api ./api
+COPY --from=builder /opt/services/open5e-api/api_v2 ./api_v2
+COPY --from=builder /opt/services/open5e-api/search ./search
+COPY --from=builder /opt/services/open5e-api/templates ./templates
+COPY --from=builder /opt/services/open5e-api/staticfiles ./staticfiles
+COPY --from=builder /opt/services/open5e-api/db.sqlite3 ./db.sqlite3
+COPY --from=builder /opt/services/open5e-api/manage.py ./manage.py
+COPY --from=builder /opt/services/open5e-api/newrelic.ini ./newrelic.ini
+
+ENV PATH="/opt/services/open5e-api/.venv/bin:$PATH"
+
+RUN python -m gunicorn --version
+
+CMD ["python", "-m", "gunicorn", "-b", ":8888", "server.wsgi:application"]