django-sloop 1.0.6

Django application to send push notifications to IOS and Android devices using Amazon SNS.

This package contains some tools that will ease the implementation of push notifications using AWS SNS and other backends into django projects.

Django-Sloop

Installation

1. Install the package via Github or PIP (pip install django-sloop)

2. Add django_sloop to the INSTALLED_APPS list in the settings file.

3. Extend the django_sloop.models.AbstractSNSDevice class and create your own push token device model.

# models.py

from django_sloop.models import AbstractSNSDevice


class Device(AbstractSNSDevice):
    pass
    
    # (Optional) if you need to override Meta.
    class Meta(AbstractSNSDevice.Meta):
        pass

4. Make sure that you fill necessary information at the settings file:

# settings.py

DJANGO_SLOOP_SETTINGS = {
    "AWS_REGION_NAME": "",
    "AWS_ACCESS_KEY_ID": "",
    "AWS_SECRET_ACCESS_KEY": "",
    "SNS_IOS_APPLICATION_ARN": "test_ios_arn",
    "SNS_IOS_SANDBOX_ENABLED": False,
    "SNS_ANDROID_APPLICATION_ARN": "test_android_arn",
    "LOG_SENT_MESSAGES": False,  # False by default.
    "DEFAULT_SOUND": "",
    "DEVICE_MODEL": "module_name.Device",
}

You cannot change the DEVICE_MODEL setting during the lifetime of a project (i.e. once you have made and migrated models that depend on it) without serious effort. The model it refers to must be available in the first migration of the app that it lives in.

5. Create migrations for newly created Device model and migrate.

Note: django_sloop's migrations must run after your Device is created. If you run into a problem while running migrations add following to the your migration file where the Device is created.

run_before = [
   ('django_sloop', '0001_initial'),
]

6. Add django_sloop.models.PushNotificationMixin to your User model.

class User(PushNotificationMixin, ...):
    pass

user.send_push_notification_async(message="Sample push notification.")

7. Add django_sloop.admin.SloopAdminMixin to your UserAdmin to enable sending push messages to users from Django admin panel.

# admin.py

from django_sloop.admin import SloopAdminMixin
from django.contrib import admin

class UserAdmin(SloopAdminMixin, admin.ModelAdmin):
    
    actions = ("send_push_notification", )
    

8. Add django rest framework urls to create and delete device.

# urls.py
from django.urls import path
from django.urls import include

urlpatterns = [
    # ...
    path('api/devices/', include('django_sloop.urls')),
    # ...
]

Done!