Metadata-Version: 1.1
Name: django-pwa
Version: 1.0.1
Summary: A Django app to include a manifest.json and Service Worker instance to enable progressive web app behavior 
Home-page: http://github.com/silviolleite/django-pwa
Author: Silvio Luis
Author-email: silviolleite@gmail.com
License: MIT License
Description: django-pwa

        ==========

        

        |Build Status| |Maintainability| |codecov| |PyPI - Downloads| |PyPI -

        Downloads|

        

        This Django app turns your project into a `progressive web

        app <https://developers.google.com/web/progressive-web-apps/>`__.

        Navigating to your site on an Android phone will prompt you to add the

        app to your home screen.

        

        .. figure:: https://github.com/silviolleite/django-pwa/raw/master/images/screenshot1.png

           :alt: Prompt for install

        

           Prompt for install

        

        Launching the app from your home screen will display your app `without

        browser

        chrome <https://github.com/silviolleite/django-pwa/raw/master/images/screenshot2.png>`__.

        As such, it’s critical that your application provides all navigation

        within the HTML (no reliance on the browser back or forward button).

        

        Requirements

        ============

        

        Progressive Web Apps require HTTPS unless being served from localhost.

        If you’re not already using HTTPS on your site, check out `Let’s

        Encrypt <https://letsencrypt.org/>`__ and

        `ZeroSSL <https://zerossl.com/>`__.

        

        Installation

        ============

        

        Install from PyPI:

        

        ::

        

           pip install django-pwa

        

        Configuration

        =============

        

        Add ``pwa`` to your list of ``INSTALLED_APPS`` in settings.py:

        

        .. code:: python

        

           INSTALLED_APPS = [

               ...

               'pwa',

               ...

           ]

        

        Configure your app name, description, and icons in settings.py:

        

        .. code:: python

        

           PWA_APP_NAME = 'My App'

           PWA_APP_DESCRIPTION = "My app description"

           PWA_APP_THEME_COLOR = '#0A0302'

           PWA_APP_BACKGROUND_COLOR = '#ffffff'

           PWA_APP_DISPLAY = 'standalone'

           PWA_APP_ORIENTATION = 'any'

           PWA_APP_START_URL = '/'

           PWA_APP_ICONS = [

               {

                   'src': '/static/images/my_app_icon.png',

                   'sizes': '160x160'

               }

           ]

           PWA_APP_DIR = 'ltr'

           PWA_APP_LANG = 'en-US'

        

        All settings are optional, and the app will work fine with its internal

        defaults. Highly recommend setting at least ``PWA_APP_NAME`` and

        ``PWA_APP_DESCRIPTION``.

        

        Add the progressive web app URLs to urls.py:

        

        .. code:: python

        

           from django.urls import path, include

        

           urlpatterns = [

               ...

               path('', include('pwa.urls')),  # You MUST use an empty string as the URL prefix

               ...

           ]

        

        Inject the required meta tags in your base.html (or wherever your HTML

        <head> is defined):

        

        .. code:: html

        

           {% load pwa %}

        

           <head>

               ...

               {% progressive_web_app_meta %}

               ...

           </head>

        

        Troubleshooting

        ===============

        

        While running the Django test server:

        

        1. Verify that ``/manifest.json`` is being served

        2. Verify that ``/serviceworker.js`` is being served

        3. Verify that ``/offline`` is being served

        4. Use the Application tab in the Chrome Developer Tools to verify the

           progressive web app is configured correctly.

        5. Use the “Add to homescreen” link on the Application Tab to verify you

           can add the app successfully.

        

        The Service Worker

        ==================

        

        By default, the service worker implemented by this app is:

        

        .. code:: js

        

           // Base Service Worker implementation.  To use your own Service Worker, set the PWA_SERVICE_WORKER_PATH variable in settings.py

        

           var staticCacheName = "django-pwa-v" + new Date().getTime();

           var filesToCache = [

               '/offline',

               '/css/django-pwa-app.css',

               '/images/icons/icon-72x72.png',

               '/images/icons/icon-96x96.png',

               '/images/icons/icon-128x128.png',

               '/images/icons/icon-144x144.png',

               '/images/icons/icon-152x152.png',

               '/images/icons/icon-192x192.png',

               '/images/icons/icon-384x384.png',

               '/images/icons/icon-512x512.png',

           ];

        

           // Cache on install

           self.addEventListener("install", event => {

               this.skipWaiting();

               event.waitUntil(

                   caches.open(staticCacheName)

                       .then(cache => {

                           return cache.addAll(filesToCache);

                       })

               )

           });

        

           // Clear cache on activate

           self.addEventListener('activate', event => {

               event.waitUntil(

                   caches.keys().then(cacheNames => {

                       return Promise.all(

                           cacheNames

                               .filter(cacheName => (cacheName.startsWith("django-pwa-")))

                               .filter(cacheName => (cacheName !== staticCacheName))

                               .map(cacheName => caches.delete(cacheName))

                       );

                   })

               );

           });

        

           // Serve from Cache

           self.addEventListener("fetch", event => {

               event.respondWith(

                   caches.match(event.request)

                       .then(response => {

                           return response || fetch(event.request);

                       })

                       .catch(() => {

                           return caches.match('offline');

                       })

               )

           });

        

        Adding Your Own Service Worker

        ==============================

        

        By default, the service worker implemented by this app is empty. To add

        service worker functionality, you’ll want to create a

        ``serviceworker.js`` or similarly named template in a template

        directory, and then point at it using the PWA_SERVICE_WORKER_PATH

        variable (PWA_APP_FETCH_URL is passed through).

        

        .. code:: python

        

           PWA_SERVICE_WORKER_PATH = 'my_app/serviceworker.js'

        

        The offline view

        ================

        

        By default, the offline view is implemented in

        ``templates/offline.html`` You can overwrite it in a template directory

        if you continue using the default ``serviceworker.js``.

        

        Feedback

        ========

        

        I welcome your feedback and pull requests. Enjoy!

        

        License

        =======

        

        All files in this repository are distributed under the MIT license.

        

        .. |Build Status| image:: https://travis-ci.org/silviolleite/django-pwa.svg

           :target: https://travis-ci.org/silviolleite/django-pwa

        .. |Maintainability| image:: https://api.codeclimate.com/v1/badges/246542ea921058c4f76f/maintainability

           :target: https://codeclimate.com/github/silviolleite/django-pwa/maintainability

        .. |codecov| image:: https://codecov.io/gh/silviolleite/django-pwa/branch/master/graph/badge.svg

           :target: https://codecov.io/gh/silviolleite/django-pwa

        .. |PyPI - Downloads| image:: https://img.shields.io/pypi/dd/django-pwa.svg

           :target: https://pypi.org/project/django-pwa/

        .. |PyPI - Downloads| image:: https://img.shields.io/pypi/v/django-pwa.svg

           :target: https://pypi.org/project/django-pwa

        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
