Replace Vagrant with Docker Compose

Author: voyc-jean

.gitignore

@@ -1,4 +1,3 @@
-.vagrant
 sandbox/db.sqlite3
 docs/_build
 dist/*

docker-compose.yml

@@ -0,0 +1,41 @@
+services:
+  django: &django
+    build:
+      context: .
+      dockerfile: sandbox/Dockerfile
+    entrypoint: /app/entrypoint
+    environment:
+      REDIS_HOST: redis
+      REDIS_PORT: 6379
+      REDIS_DB: 0
+    volumes:
+      - ./sandbox:/app
+    ports:
+      - "8080:8080"
+    depends_on:
+      redis:
+        condition: service_healthy
+
+  redis:
+    image: redis:7-alpine
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+
+  celery:
+    depends_on:
+      - django
+      - redis
+    <<: *django
+    ports: []
+    entrypoint: celery -A sandbox worker --loglevel=INFO
+
+  rqworker:
+    depends_on:
+      - django
+      - redis
+    <<: *django
+    ports: []
+    entrypoint: python manage.py rqworker

docs/contributing.rst

@@ -38,24 +38,16 @@ all supported Django and Python versions::
 Sandbox VM
 ==========
 
-There is a ``VagrantFile`` for setting up a sandbox VM where you can play around
-with the functionality.  Bring up the Vagrant box::
+Alternatively, there's a ``docker compose`` stack for setting up a sandbox
+environment where you can play around with the functionality.
+Bring up the compose stack::
 
-    $ vagrant up
+    $ docker compose up
 
-This may take a while but will set up a Ubuntu Precise64 VM with RabbitMQ
-installed.  You can then SSH into the machine::
+The stack will start with Celery as a broker by default. You can Alternatively
+make use of rq by supplying the `Q` env var:
 
-    $ vagrant ssh
-    $ cd /vagrant/sandbox
-
-You can now decide to run the Celery implementation::
-
-    $ honcho -f Procfile.celery start
-
-Or you can run the RQ implementation::
-
-    $ honcho -f Procfile.rq start
+    $ Q=rq docker compose up
 
 The above commands will start a Django runserver and the selected task worker.
 The dummy site will be available at ``http://localhost:8080`` on your host

docs/installation.rst

@@ -35,12 +35,12 @@ up the `django-rq installation guide`_ for more details.
 Set up a cache
 ~~~~~~~~~~~~~~
 
-You also need to ensure you have `a cache set up`_.  Most likely, you'll be using
-memcache so your settings will include something like::
+You also need to ensure you have `a cache set up`_.  Most likely, you'll be using Redis
+or memcache so your settings will include something like::
 
     CACHES = {
         'default': {
-            'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
+            'BACKEND': 'django.core.cache.backends.memcached.PyMemcacheCache',
             'LOCATION': '127.0.0.1:11211',
         }
     }

pyproject.toml

@@ -53,6 +53,11 @@ coverage = {version = ">=7.0", extras = ["toml"]}
 celery = ">=5.0"
 django-rq = ">=3"
 
+
+[tool.poetry.group.sandbox.dependencies]
+redis = "^7.1.0"
+django-debug-toolbar = "^6.1.0"
+
 [tool.poetry.extras]
 celery = ["celery"]
 rq = ["django-rq"]

sandbox/Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.12-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+ENV POETRY_VIRTUALENVS_CREATE="false"
+
+# Install lightweight build tools for any binary Python dependencies.
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pip install --upgrade pip \
+    && pip install --no-cache-dir "poetry>=2"
+    # && pip install --no-cache-dir -e .[celery,rq]
+
+COPY . /package/
+WORKDIR /package
+
+RUN poetry install --with sandbox
+
+WORKDIR /app

sandbox/Procfile.celery

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+python manage.py migrate
+python manage.py loaddata fixture.json
+python manage.py runserver 0.0.0.0:8080