django-jsignature3 0.9.0

Provides a simple way to handle jSignature jQuery plugin through a django form.

A simple way to use jSignature jQuery plugin in your Django projects.

It provides:

• A form field and a form widget to handle jquery plugin through a Django form;

• A model field to store a captured signature;

• A mixin adding two fields (signature / signature_date) in any of your Django models.

INSTALL

pip install django_jsignature3

USAGE

• Add jsignature to your INSTALLED_APPS:

# settings.py
INSTALLED_APPS = (
...
'jsignature',
)

In a Form

• Use provided form field and widget:

# forms.py
from django import forms
from jsignature.forms import JSignatureField

class SignatureForm(forms.Form):
    signature = JSignatureField()

• In your template

{{ form.media }}
<form action="." method="POST">
    {% for field in form %}
        {{ field.label_tag }}
        {{ field }}
    {% endfor %}
    <input type="submit" value="Save"/>
    {% csrf_token %}
</form>

• Render image after form validation:

# views.py
from jsignature.utils import draw_signature
from myapp.forms import SignatureForm

def my_view(request):
    form = SignatureForm(request.POST or None)
    if form.is_valid():
        signature = form.cleaned_data.get('signature')
        if signature:
            # as an image
            signature_picture = draw_signature(signature)
            # or as a file
            signature_file_path = draw_signature(signature, as_file=True)

In Django Admin

# models.py
from jsignature.fields import JSignatureField


class Firma(models.Model):
    firma = JSignatureField(blank=True, null=True)

If you wan to store signatures, provided mixin gives a signature and a signature_date that update themselves:

from django.db import models
from jsignature.mixins import JSignatureFieldsMixin

class JSignatureModel(JSignatureFieldsMixin):
    name = models.CharField()

CUSTOMIZATION

JSignature plugin options are available in python:

• Globally, in your settings:

# settings.py
JSIGNATURE_WIDTH = 500
JSIGNATURE_HEIGHT = 200

• Specifically, in your form:

# forms.py
from jsignature.forms import JSignatureField
from jsignature.widgets import JSignatureWidget

JSignatureField(widget=JSignatureWidget(jsignature_attrs={'color': '#CCC'}))

Available settings are:

• JSIGNATURE_WIDTH (width)

• JSIGNATURE_HEIGHT (height)

• JSIGNATURE_COLOR (color)

• JSIGNATURE_BACKGROUND_COLOR (background-color)

• JSIGNATURE_DECOR_COLOR (decor-color)

• JSIGNATURE_LINE_WIDTH (lineWidth)

• JSIGNATURE_UNDO_BUTTON (UndoButton)

• JSIGNATURE_RESET_BUTTON (ResetButton)

AUTHORS

• Florent Lebreton <[e-mail]>

MANTAINERS

• Adremides <[e-mail]>