181 lines
4.5 KiB
ReStructuredText
181 lines
4.5 KiB
ReStructuredText
A simple way to use `jSignature jQuery plugin <https://github.com/brinley/jSignature/blob/master/README.md>`_ in your `Django <https://www.djangoproject.com>`_ 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.
|
|
|
|
.. image:: https://img.shields.io/pypi/v/django-jsignature.svg
|
|
:target: https://pypi.python.org/pypi/django-jsignature/
|
|
:alt: Latest PyPI version
|
|
|
|
.. image:: https://travis-ci.org/fle/django-jsignature.png?branch=master
|
|
:target: https://travis-ci.org/fle/django-jsignature
|
|
:alt: Build status
|
|
|
|
.. image:: https://coveralls.io/repos/fle/django-jsignature/badge.png
|
|
:target: https://coveralls.io/r/fle/django-jsignature
|
|
:alt: Coverage status
|
|
|
|
.. image:: https://github.com/fle/django-jsignature/blob/master/screen.png
|
|
|
|
==================
|
|
INSTALL
|
|
==================
|
|
|
|
For now:
|
|
|
|
::
|
|
|
|
pip install django-jsignature
|
|
|
|
==================
|
|
USAGE
|
|
==================
|
|
|
|
* Add ``jsignature`` to your ``INSTALLED_APPS``:
|
|
|
|
::
|
|
|
|
# settings.py
|
|
INSTALLED_APPS = (
|
|
...
|
|
'jsignature',
|
|
)
|
|
|
|
* 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)
|
|
|
|
* By default, jSignature is made to work outside of admin, requiring that
|
|
you include the jQuery library in your ``<head>``.
|
|
|
|
If you want to use jSignature in the Django admin site, set the
|
|
``JSIGNATURE_JQUERY`` setting to ``admin``. Otherwise if set to any url
|
|
pointing to jQuery, it will be automatically included.
|
|
|
|
==================
|
|
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)
|
|
|
|
==================
|
|
IN YOUR MODELS
|
|
==================
|
|
|
|
If you want 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()
|
|
|
|
|
|
==================
|
|
Example project
|
|
==================
|
|
|
|
If you want to have a demo of this package, just use the example project:
|
|
|
|
::
|
|
|
|
git clone https://github.com/fle/django-jsignature.git
|
|
cd django-jsignature
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
pip install -r requirements.txt
|
|
pip install -e .
|
|
cd example_project
|
|
./manage.py migrate
|
|
./manage.py createsuperuser
|
|
|
|
Fill the user info, launch django with ``./manage.py runserver`` and head over to
|
|
`http://127.0.0.1:8000/ <http://127.0.0.1:8000/>`_ and login with the
|
|
credentials your provided.
|
|
|
|
==================
|
|
AUTHORS
|
|
==================
|
|
|
|
* Florent Lebreton <florent.lebreton@makina-corpus.com>
|
|
* Sébastien Corbin <sebastien.corbin@makina-corpus.com>
|
|
|
|
|makinacom|_
|
|
|
|
.. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif
|
|
.. _makinacom: http://www.makina-corpus.com
|
|
|