Added Django Example (#152)

* Added django example

* Added django examples tests to CI

* Lint fixes

* Fixed security issue with DjangoWorker.Dockerfile

* Cleanup

Author: Nusnus

.github/workflows/examples.yml

@@ -0,0 +1,62 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: examples
+
+on:
+  push:
+    branches: ["main"]
+    paths:
+      - "**.py"
+      - "**.txt"
+      - ".github/workflows/examples.yml"
+      - "**.toml"
+  pull_request:
+    paths:
+      - "**.py"
+      - "**.txt"
+      - "**.toml"
+      - ".github/workflows/examples.yml"
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+jobs:
+  django:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+        os: ["ubuntu-latest"]
+
+    steps:
+      - name: Install apt packages
+        if: startsWith(matrix.os, 'ubuntu-')
+        run: |
+          sudo apt update
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: '**/setup.py'
+      - name: Install dependencies
+        working-directory: examples/django
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run Migrations
+        working-directory: examples/django
+        run: |
+          ./manage.py migrate
+
+      - name: Run tests
+        working-directory: examples/django
+        timeout-minutes: 5
+        run: |
+          export DJANGO_SETTINGS_MODULE=proj.settings
+          pytest -vv tests -n auto

.pre-commit-config.yaml

@@ -40,6 +40,7 @@ repos:
       - id: check-ast
       - id: check-case-conflict
       - id: check-docstring-first
+        exclude: "examples/django/proj/settings.py"
       - id: check-json
       - id: check-merge-conflict
       - id: check-shebang-scripts-are-executable

examples/django/demoapp/__init__.py

@@ -0,0 +1,20 @@
+# Generated by Django 2.2.1 on 2019-05-24 21:37
+
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Widget",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("name", models.CharField(max_length=140)),
+            ],
+        ),
+    ]

examples/django/demoapp/migrations/0001_initial.py

@@ -0,0 +1,5 @@
+from django.db import models
+
+
+class Widget(models.Model):
+    name = models.CharField(max_length=140)

examples/django/demoapp/migrations/__init__.py

@@ -0,0 +1,32 @@
+# Create your tasks here
+
+from celery import shared_task
+
+from .models import Widget
+
+
+@shared_task
+def add(x, y):
+    return x + y
+
+
+@shared_task
+def mul(x, y):
+    return x * y
+
+
+@shared_task
+def xsum(numbers):
+    return sum(numbers)
+
+
+@shared_task
+def count_widgets():
+    return Widget.objects.count()
+
+
+@shared_task
+def rename_widget(widget_id, name):
+    w = Widget.objects.get(id=widget_id)
+    w.name = name
+    w.save()

examples/django/demoapp/models.py

@@ -0,0 +1 @@
+# Create your views here.

examples/django/demoapp/tasks.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "proj.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

examples/django/demoapp/views.py

@@ -0,0 +1,5 @@
+# This will make sure the app is always imported when
+# Django starts so that shared_task will use this app.
+from .celery import app as celery_app
+
+__all__ = ("celery_app",)