added django_example for asgi servers with uvicorn

examples/server/asgi/django_example/.gitignore

@@ -0,0 +1,2 @@
+.env
+__pycache__

examples/server/asgi/django_example/Procfile

@@ -0,0 +1 @@
+gunicorn myproject.asgi:application -k uvicorn.workers.UvicornWorker

examples/server/asgi/django_example/README.md

@@ -0,0 +1,8 @@
+# Django with SocketIO
+
+# Initialization
+- pip install -r requirements.txt
+(in virtual environment)
+
+- python server.py 
+to start app

examples/server/asgi/django_example/core/asgi.py

@@ -0,0 +1,84 @@
+"""
+ASGI config for core project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings')
+django_asgi_app = get_asgi_application()
+
+
+#its important to make all other imports below this comment
+import socketio
+from django_io.models import Message
+from django_io.serializers import message_serializer
+from django_io.utils import generate_short_id
+from socketio.exceptions import ConnectionRefusedError
+from datetime import datetime, timezone
+from asgiref.sync import sync_to_async
+import json
+from dotenv import load_dotenv
+load_dotenv()
+
+mgr = socketio.AsyncRedisManager(os.getenv('REDIS_URL'))
+sio = socketio.AsyncServer(async_mode="asgi", client_manager=mgr, cors_allowed_origins="*")
+application = socketio.ASGIApp(sio, django_asgi_app)
+
+# application = get_asgi_application()
+
+
+#establishes a connection with the client
+@sio.on("connect")
+async def connect(sid, env, auth):
+    if auth:
+        print("SocketIO connect")
+        sio.enter_room(sid, "feed")
+        await sio.emit("connect", f"Connected as {sid}")
+
+#communication with orm 
+def store_and_return_message(data):
+    data = json.loads(data)
+    instance = Message.objects.create(
+        author = data["username"],
+        message = data["message"]
+    )
+    instance.save()
+    message = message_serializer(instance)
+    return message
+
+
+
+# listening to a 'message' event from the client
+@sio.on('message')
+async def print_message(sid, data):
+    print("Socket ID", sid)
+    message = await sync_to_async(store_and_return_message, thread_sensitive=True)(data) #communicating with orm
+    print(message)
+    await sio.emit("new_message", message, room="feed")
+
+
+
+@sio.on("disconnect")
+async def disconnect(sid):
+    print("SocketIO disconnect")
+
+
+#extra events
+@sio.on('left')
+async def left_room(sid, data):
+    sio.leave_room(sid, "feed") 
+    await sio.emit("user_left", f'{data} left', room="feed")
+    print(f'{sid} Left')
+
+@sio.on("joined")
+async def joined(sid, data):
+    await sio.emit("user_joined", f'{data} connected', room="feed")
+    print(f'{data} connected')
+

examples/server/asgi/django_example/core/settings.py

@@ -0,0 +1,127 @@
+"""
+Django settings for core project.
+
+Generated by 'django-admin startproject' using Django 4.0.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.0/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-e!)1@kh2v$a9_v$pv*oc5hsr-!^**&87ti-zsci&0e9@zhxt%0'
+
+# 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',
+    'socketio',
+    'django_io'
+ 
+]
+
+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 = 'core.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 = 'core.wsgi.application'
+ASGI_APPLICATION = 'core.asgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.0/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.0/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/4.0/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.0/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

examples/server/asgi/django_example/core/urls.py

@@ -0,0 +1,21 @@
+"""core URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

examples/server/asgi/django_example/core/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for core project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings')
+
+application = get_wsgi_application()

examples/server/asgi/django_example/django_io/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

examples/server/asgi/django_example/django_io/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DjangoIoConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'django_io'

examples/server/asgi/django_example/django_io/migrations/0001_initial.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.0.1 on 2022-01-10 11:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Message',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('author', models.CharField(max_length=255)),
+                ('message', models.TextField()),
+                ('timestamp', models.DateTimeField(auto_now_add=True)),
+                ('short_id', models.CharField(default='MR4QW42EC', max_length=255)),
+            ],
+        ),
+    ]

examples/server/asgi/django_example/django_io/models.py

@@ -0,0 +1,12 @@
+from datetime import datetime
+from django.db import models
+
+from django_io.utils import generate_short_id
+
+# Create your models here.
+
+class Message(models.Model):
+    author = models.CharField(max_length=255)
+    message = models.TextField()
+    timestamp = models.DateTimeField(auto_now_add=True)
+    short_id = models.CharField(default=generate_short_id(), max_length=255)

examples/server/asgi/django_example/django_io/serializers.py

@@ -0,0 +1,17 @@
+from datetime import datetime
+
+
+def message_serializer(a) -> dict:
+    return{
+        "author": a.author,
+        "message": a.message,
+        "timestamp": (a.timestamp).strftime("%a. %I:%M %p"),
+        "short_id": a.short_id
+    }
+
+# def message_serializer(a) -> dict:
+#     return{
+#         "author": a["username"],
+#         "message": a["message"],
+#         "timestamp": datetime.now().strftime("%a. %I:%M %p")
+#     }

examples/server/asgi/django_example/django_io/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

examples/server/asgi/django_example/django_io/utils.py

@@ -0,0 +1,4 @@
+import random
+
+def generate_short_id(size=9, chars='ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'):
+    return ''.join(random.choice(chars) for _ in range(size))

examples/server/asgi/django_example/django_io/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

examples/server/asgi/django_example/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

examples/server/asgi/django_example/requirements.txt

@@ -0,0 +1,24 @@
+aioredis==2.0.1
+asgiref==3.4.1
+async-timeout==4.0.2
+bidict==0.21.4
+click==8.0.3
+Deprecated==1.2.13
+Django==4.0.1
+gunicorn==20.1.0
+h11==0.12.0
+httptools==0.3.0
+packaging==21.3
+pyparsing==3.0.6
+python-dotenv==0.19.2
+python-engineio==4.3.0
+python-socketio==5.5.0
+PyYAML==6.0
+redis==4.1.0
+sqlparse==0.4.2
+typing_extensions==4.0.1
+uvicorn==0.16.0
+uvloop==0.16.0
+watchgod==0.7
+websockets==10.1
+wrapt==1.13.3

examples/server/asgi/django_example/server.py

@@ -0,0 +1,4 @@
+import uvicorn
+
+if __name__ == "__main__":
+    uvicorn.run('core.asgi:application', reload=True)