Add devcontainer setup

Author: DavidMStraub

.devcontainer/Dockerfile

@@ -0,0 +1,39 @@
+FROM mcr.microsoft.com/devcontainers/python:3.11
+
+
+RUN apt-get update && apt-get install -y \
+  gettext appstream pkg-config libcairo2-dev gir1.2-gtk-3.0 \
+  libgirepository1.0-dev libicu-dev libopencv-dev tesseract-ocr \
+  tesseract-ocr-all gir1.2-pango-1.0 \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN pip install opencv-python
+RUN pip install gramps==6.0.1
+
+ENV LANGUAGE=en
+ENV OMP_NUM_THREADS=1
+ENV GRAMPSWEB_USER_DB_URI=sqlite:////workspaces/web-api/data/users.sqlite
+ENV GRAMPSWEB_MEDIA_BASE_DIR=/workspaces/web-api/data/media
+ENV GRAMPSWEB_SEARCH_INDEX_DB_URI=sqlite:////workspaces/web-api/data/indexdir/search_index.db
+ENV GRAMPSWEB_STATIC_PATH=/workspaces/web-api/data/static
+ENV GRAMPSWEB_THUMBNAIL_CACHE_CONFIG__CACHE_DIR=/workspaces/web-api/data/thumbnail_cache
+ENV GRAMPSWEB_REPORT_DIR=/workspaces/web-api/data/reports_cache
+ENV GRAMPSWEB_EXPORT_DIR=/workspaces/web-api/data/export_cache
+ENV GRAMPSHOME=/workspaces/web-api/data/
+ENV GRAMPS_DATABASE_PATH=/workspaces/web-api/data/grampsdb
+ENV GRAMPSWEB_TREE=Gramps\ Web
+# Do not use this value in production!!
+ENV GRAMPSWEB_SECRET_KEY=QAVoeYDzkQves9iDZ5PkxfdUoVElVMVYPqz-QXha6yE
+ENV GRAMPSWEB_CORS_ORIGINS="*"
+ENV GRAMPSWEB_VECTOR_EMBEDDING_MODEL=sentence-transformers/distiluse-base-multilingual-cased-v2
+ENV GRAMPSWEB_CELERY_CONFIG__broker_url=redis://redis:6379/0
+ENV GRAMPSWEB_CELERY_CONFIG__result_backend=redis://redis:6379/0
+
+# CPU-only version of PyTorch
+RUN pip install torch --index-url https://download.pytorch.org/whl/cpu
+RUN pip install sentence-transformers
+
+# download and cache sentence transformer model
+RUN python3 -c "from sentence_transformers import SentenceTransformer; \
+model = SentenceTransformer('sentence-transformers/distiluse-base-multilingual-cased-v2')";
+

.devcontainer/devcontainer.json

@@ -0,0 +1,28 @@
+{
+  "name": "Gramps Web API Dev",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "devcontainer",
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+  "postCreateCommand": "scripts/start_dev_container.sh",
+  "postStartCommand": "pip install -e .[ai]",
+  "appPort": ["5555:5555"],
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.pylint",
+        "ms-python.vscode-pylance",
+        "ms-python.black-formatter",
+        "GitHub.vscode-pull-request-github",
+        "GitHub.copilot"
+      ],
+      "settings": {
+        "python.experiments.optOutFrom": ["pythonTestAdapter"],
+        "editor.formatOnSave": true,
+        "files.trimTrailingWhitespace": true,
+        "[python]": {
+          "editor.defaultFormatter": "ms-python.black-formatter"
+        }
+      }
+    }
+  }
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3.8"
+services:
+  devcontainer:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ../..:/workspaces:cached
+    command: sleep infinity
+
+  redis:
+    image: valkey/valkey:alpine
+    restart: unless-stopped
+    ports:
+      - "6379:6379"

.gitignore

@@ -7,6 +7,7 @@ Pipfile.lock
 .venv
 *.ipynb
 
+data/
 indexdir/
 indexdir_empty/
 thumbnail_cache/

.vscode/tasks.json

@@ -0,0 +1,31 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Serve Web API",
+      "type": "shell",
+      "command": "python3 -O -m gramps_webapi run --port 5555 --host 0.0.0.0",
+      "isBackground": true,
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "runOptions": {
+        "instanceLimit": 1
+      }
+    },
+    {
+      "label": "Start Celery Worker",
+      "type": "shell",
+      "command": "celery -A gramps_webapi.celery worker --loglevel=INFO --concurrency=1",
+      "isBackground": true,
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "runOptions": {
+        "instanceLimit": 1
+      }
+    }
+  ]
+}

gramps_webapi/__main__.py

@@ -89,7 +89,15 @@ def cli(ctx, config):
 @click.option("--use-wsgi", is_flag=True, help="Add a WSGI wrapper around the server")
 @click.pass_context
 def run(
-    ctx, port, tree, host, open_browser, debug_level, log_file, max_workers, use_wsgi
+    ctx,
+    port,
+    tree,
+    host,
+    open_browser,
+    debug_level,
+    log_file,
+    max_workers,
+    use_wsgi,
 ):
     """Run the app."""
     app = ctx.obj["app"]
@@ -133,7 +141,7 @@ def open_webbrowser_after_start():
             threads=max_workers,
         )
     else:
-        app.run(port=port, threaded=True)
+        app.run(port=port, threaded=True, host=host)
     print()
     print("Stopping Gramps Web API server...")
 

scripts/start_dev_container.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Dev Container startup script
+set -e
+
+# Install dependencies
+pip install -r requirements-dev.txt
+pip install -e .[ai]
+
+mkdir -p /workspaces/web-api/data/grampsdb
+# Check if the grampsdb directory is empty
+if [ -z "$(ls -A /workspaces/web-api/data/grampsdb)" ]; then
+    echo "Database directory is empty, initializing..."
+    # Create necessary directories if they don't exist
+    mkdir -p /workspaces/web-api/data/grampsdb
+    gramps -C Gramps\ Web -i  /usr/local/share/doc/gramps/example/gramps/example.gramps --config=database.backend:sqlite --config=database.path:/workspaces/web-api/data/grampsdb
+    mkdir -p /workspaces/web-api/data/media
+    cp -a /usr/local/share/doc/gramps/example/gramps/. /workspaces/web-api/data/media/
+else
+    echo "Database directory already contains data, skipping initialization"
+fi
+
+python3 -m gramps_webapi user add owner owner --fullname Owner --role 4 \
+  && python3 -m gramps_webapi user add editor editor --fullname Editor --role 3 \
+  && python3 -m gramps_webapi user add contributor contributor --fullname Contributor --role 2 \
+  && python3 -m gramps_webapi user add member member --fullname Member --role 1