initial

Author: Siddharth

.gitignore

@@ -0,0 +1,2 @@
+venv/*
+*.pyc

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.7.3-slim-stretch
+
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+RUN mkdir /app
+
+RUN apt update && apt upgrade -y && \
+    apt install gcc default-libmysqlclient-dev -y && \
+    pip install --upgrade pip
+WORKDIR /app
+
+COPY . /app/
+RUN pip install -r requirements.txt
+
+EXPOSE 8000
+
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

Procfile

@@ -0,0 +1,2 @@
+web: python manage.py runserver 0.0.0.0:8000
+cmd: celery -A proj worker -l INFO

README.rst

@@ -0,0 +1,66 @@
+==============================================================
+ Example Django project using Celery
+==============================================================
+
+* For sqlite testing, we can implement migration through the docker file via adding another command. `python manage.py makemigrations` and `python manage.py migrate`
+
+Credits: Originally from https://github.com/celery/celery/tree/master/examples/django
+
+Modified the app file just to add a hello-world end point (/api-check/) for validation.
+
+Contents
+========
+
+``proj/``
+---------
+
+This is a project in itself, created using
+``django-admin.py startproject proj``, and then the settings module
+(``proj/settings.py``) was modified to add ``demoapp`` to
+``INSTALLED_APPS``
+
+``proj/celery.py``
+----------
+
+This module contains the Celery application instance for this project,
+we take configuration from Django settings and use ``autodiscover_tasks`` to
+find task modules inside all packages listed in ``INSTALLED_APPS``.
+
+``demoapp/``
+------------
+
+Example generic app.  This is decoupled from the rest of the project by using
+the ``@shared_task`` decorator.  This decorator returns a proxy that always
+points to the currently active Celery instance.
+
+Installing requirements
+=======================
+
+The settings file assumes that ``rabbitmq-server`` is running on ``localhost``
+using the default ports. More information here:
+
+http://docs.celeryproject.org/en/latest/getting-started/brokers/rabbitmq.html
+
+In addition, some Python requirements must also be satisfied:
+
+.. code-block:: console
+
+    $ pip install -r requirements.txt
+
+Starting the worker
+===================
+
+.. code-block:: console
+
+    $ celery -A proj worker -l INFO
+
+Running a task
+===================
+
+.. code-block:: console
+
+    $ python ./manage.py shell
+    >>> from demoapp.tasks import add, mul, xsum
+    >>> res = add.delay(2,3)
+    >>> res.get()
+    5

demoapp/__init__.py

@@ -0,0 +1,21 @@
+# Generated by Django 2.2.1 on 2019-05-24 21:37
+
+from django.db import migrations, 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)),
+            ],
+        ),
+    ]

demoapp/migrations/0001_initial.py

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

demoapp/migrations/__init__.py

@@ -0,0 +1,32 @@
+# Create your tasks here
+
+from demoapp.models import Widget
+
+from celery import shared_task
+
+
+@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()

demoapp/models.py

@@ -0,0 +1,7 @@
+# Create your views here.
+from rest_framework.views import APIView
+from rest_framework.response import Response
+
+class HomeAPIView(APIView):
+    def get(self, request, format=None):
+        return Response({"desc": "hello world"})

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)

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',)

manage.py

@@ -0,0 +1,22 @@
+import os
+
+from celery import Celery
+
+# Set the default Django settings module for the 'celery' program.
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'proj.settings')
+
+app = Celery('proj')
+
+# Using a string here means the worker doesn't have to serialize
+# the configuration object to child processes.
+# - namespace='CELERY' means all celery-related configuration keys
+#   should have a `CELERY_` prefix.
+app.config_from_object('django.conf:settings', namespace='CELERY')
+
+# Load task modules from all registered Django apps.
+app.autodiscover_tasks()
+
+
+@app.task(bind=True)
+def debug_task(self):
+    print(f'Request: {self.request!r}')

proj/__init__.py

@@ -0,0 +1,149 @@
+import os
+
+# ^^^ The above is required if you want to import from the celery
+# library.  If you don't have this then `from celery.schedules import`
+# becomes `proj.celery.schedules` in Python 2.x since it allows
+# for relative imports by default.
+
+# Celery settings
+
+CELERY_BROKER_URL = 'amqp://guest:guest@localhost'
+
+#: Only add pickle to this list if your broker is secured
+#: from unwanted access (see userguide/security.html)
+CELERY_ACCEPT_CONTENT = ['json']
+CELERY_RESULT_BACKEND = 'db+sqlite:///results.sqlite'
+CELERY_TASK_SERIALIZER = 'json'
+
+
+"""
+Django settings for proj project.
+
+Generated by 'django-admin startproject' using Django 2.2.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.2/ref/settings/
+"""
+
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'l!t+dmzf97rt9s*yrsux1py_1@odvz1szr&6&m!f@-nxq6k%%p'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ['*']
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'demoapp',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'proj.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'proj.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+# DATABASES = {
+#     'default': {
+#         'ENGINE': 'django.db.backends.mysql',
+#         'HOST': '172.17.0.2',
+#         'POST': '3306',
+#         'NAME': 'testdb',
+#         'USER': 'caesar',
+#         'PASSWORD': 'toor'
+#     },
+# }
+
+
+# Password validation
+# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/2.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/2.2/howto/static-files/
+
+STATIC_URL = '/static/'

proj/celery.py

@@ -0,0 +1,21 @@
+# from django.urls import handler404, handler500, include, url  # noqa
+
+# Uncomment the next two lines to enable the admin:
+# from django.contrib import admin
+# admin.autodiscover()
+
+from django.urls import path
+from demoapp.views import HomeAPIView
+
+urlpatterns = [
+    # Examples:
+    # url(r'^$', 'proj.views.home', name='home'),
+    # url(r'^proj/', include('proj.foo.urls')),
+
+    # Uncomment the admin/doc line below to enable admin documentation:
+    # url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
+
+    # Uncomment the next line to enable the admin:
+    # url(r'^admin/', include(admin.site.urls)),
+    path('api-check/', HomeAPIView.as_view())
+]