https://github.com/mback2k/swampdragon-live

Proof of Concept / Prototype: Live updating Django templates using SwampDragon and SwampDragon-auth
https://github.com/mback2k/swampdragon-live

Last synced: about 1 year ago
JSON representation

Proof of Concept / Prototype: Live updating Django templates using SwampDragon and SwampDragon-auth

• Host: GitHub
• URL: https://github.com/mback2k/swampdragon-live
• Owner: mback2k
• License: mit
• Created: 2016-03-26T21:53:07.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-12-27T16:11:58.000Z (over 9 years ago)
• Last Synced: 2025-02-08T22:13:12.218Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
[SwampDragon-live](https://github.com/mback2k/swampdragon-live) is an

extension to [Django](https://www.djangoproject.com/) and

[SwampDragon](http://swampdragon.net/) with SwampDragon-auth and django-redis

which adds support for live updating Django template snippets on model changes.

Installation

------------

Install the latest version from pypi.python.org:

    pip install SwampDragon-live

Install the development version by cloning the source from github.com:

    pip install git+https://github.com/mback2k/swampdragon-live.git

Configuration

-------------

Add the package to your `INSTALLED_APPS`:

    INSTALLED_APPS += (

        'swampdragon',

        'swampdragon_live',

    )

Example

-------

Make sure to use django-redis as a Cache backend named 'swampdragon-live' or 'default':

    CACHES = {

        'swampdragon-live': {

            'BACKEND': 'django_redis.cache.RedisCache',

            'LOCATION': 'redis://localhost:6379/0',

            'OPTIONS': {

                'CLIENT_CLASS': 'django_redis.client.DefaultClient',

            }

        }

    }

Make sure to add the following line to your Django settings file:

    SWAMP_DRAGON_CONNECTION = ('swampdragon_auth.socketconnection.HttpDataConnection', '/data')

Load the required JavaScript template-tags within your Django template:

    {% load swampdragon_tags %}

    {% load swampdragon_live %}

Add the required JavaScript to your Django template:

    {% swampdragon_settings %}

    

    

Use the include_live template-tag instead of the default include template-tag,

with rows being a Django database QuerySet to listen for added, changed, deleted instances:

    {% include_live 'table' 'includes/table_body.html' rows=rows perms=perms %}

Use the include_live template-tag instead of the default include template-tag,

with row being a single Django database Model instance to listen for changes:

    {% include_live 'table-row' 'includes/row_cols.html' row=row perms=perms %}

Use the swampdragon_live variable within the included template to add the

required classes to the root-tag of this template, e.g. the first tag-node:

    ...

You can check if your template is being live rendered by a content pusher by

using the context variable `is_swampdragon_live` like this:

    {% if is_swampdragon_live %}

    

    {% endif %}

A real-world example can be found in the Django project WebGCal:

* https://github.com/mback2k/django-webgcal/blob/master/webgcal/apps/webgcal/templates/show_dashboard.html

* https://github.com/mback2k/django-webgcal/tree/master/webgcal/apps/webgcal/templates/includes

License

-------

* Released under MIT License

* Copyright (c) 2015-2016 Marc Hoersken