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:
.. image:: https://img.shields.io/pypi/v/django-jsignature.svg :target: https://pypi.python.org/pypi/django-jsignature/ :alt: Latest PyPI version
.. image:: https://github.com/fle/django-jsignature/actions/workflows/actions.yml/badge.svg :target: https://github.com/fle/django-jsignature/actions :alt: Build status
.. image:: https://coveralls.io/repos/github/fle/django-jsignature/badge.svg?branch=master :target: https://coveralls.io/github/fle/django-jsignature?branch=master :alt: Coverage status
.. image:: https://github.com/fle/django-jsignature/blob/master/screen.png
::
pip install django-jsignature
jsignature to your INSTALLED_APPS:.. code-block:: python
# settings.py
INSTALLED_APPS = (
...
'jsignature',
)
.. code-block:: python
# models.py
from django.db import models
from jsignature.fields import JSignatureField
class SignatureModel(models.Model):
signature = JSignatureField()
.. code-block:: html+django
{{ form.media }}
<form action="" method="post">
{{ form }}
<input type="submit" value="Save" />
{% csrf_token %}
</form>
.. code-block:: html+django
{# yourtemplate.html #}
{% load jsignature_filters %}
<img src="{{ obj.signature|signature_base64 }}" alt="{{ obj }}" />
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.
It is strongly suggested to take example from example_project, which is
located in this repo <https://github.com/fle/django-jsignature/tree/master/example_project>_
JSignature plugin options are available in python:
.. code-block:: python
# settings.py
JSIGNATURE_WIDTH = 500
JSIGNATURE_HEIGHT = 200
.. code-block:: python
# 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)If you want to store signatures easily, a provided mixin gives a signature
and a signature_date that update themselves:
.. code-block:: python
from django.db import models
from jsignature.mixins import JSignatureFieldsMixin
class JSignatureModel(JSignatureFieldsMixin):
name = models.CharField()
.. code-block:: python
# forms.py
from django import forms
from jsignature.forms import JSignatureField
class SignatureForm(forms.Form):
signature = JSignatureField()
draw_signature().. code-block:: python
# 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)
If you want to have a demo of this package, just use the example project:
.. code-block:: shell
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/>, you can also
login to the admin <http://127.0.0.1:8000/admin> with the credentials your
provided.
* Florent Lebreton <florent.lebreton@makina-corpus.com> (original author)
* Sébastien Corbin <sebastien.corbin@makina-corpus.com> (maintainer)
|makinacom|_
.. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif .. _makinacom: http://www.makina-corpus.com
** Bug fixed **
** New **
** New **
** New **
** New **
JSIGNATURE_JQUERY settings to handle usage in admin in Django 2.1+** New **
** New features **
** Internal changes **
FAQs
Use jSignature jQuery plugin in your django projects
We found that django-jsignature demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.