Skip to main content

SwampDragon-live is an extension to Django and SwampDragon which adds support for live updating Django template snippets on model changes.

Project description

[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 %}
<script type="text/javascript" src="{{ STATIC_URL }}swampdragon/js/dist/swampdragon.min.js"></script>
<script type="text/javascript" src="{{ STATIC_URL }}swampdragon/js/live/swampdragon.live.js"></script>

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:

<tr class="{{ swampdragon_live }}">...</tr>

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 %}
<style onload="alert('Hello World!');"></style>
{% 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 <info@marc-hoersken.de>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for SwampDragon-live, version 0.0.7a0
Filename, size File type Python version Upload date Hashes
Filename, size SwampDragon_live-0.0.7a0-py2-none-any.whl (10.6 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size SwampDragon-live-0.0.7a0.tar.gz (8.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page