django-app-shell 0.1.0

Easy use service workers and the app shell concept for django.

Inspired by the Using Django with service workers talk by Adrian Holovaty from the DjangoCon Europe 2016, django-app-shell aims to provide an easy to use and configure way of utilizing the app shell architecture from google.

Documentation

The full documentation is at https://django-app-shell.readthedocs.io.

Quickstart

Install Django App Shell:

pip install django-app-shell

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_app_shell.apps.DjangoAppShellConfig',
    ...
)

Add Django App Shell’s URL patterns:

from django_app_shell import urls as django_app_shell_urls


urlpatterns = [
    ...
    url(r'^', include(django_app_shell_urls)),
    ...
]

Features

• client side caching using service worker (TODO)

• easy push notification API (TODO)

• offline use of page/features using service worker (TODO)

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

0.1.0 (2017-05-28)

• First release on PyPI.