File: web-development.rst

package info (click to toggle)
segno 1.6.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 4,072 kB
  • sloc: python: 9,936; makefile: 162; javascript: 16
file content (177 lines) | stat: -rw-r--r-- 4,634 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
Web development
===============

A few proposals how to use Segno with popular Python web application
frameworks.


Flask
-----

There are various ways to output QR codes in Jinja templates in conjunction
with Flask. See also the Flask example in the repository:
https://github.com/heuer/segno/tree/master/examples/flask_qrcode


Data URIs
~~~~~~~~~

Create a QR code in the Flask view and use the :py:func:`segno.QRCode.svg_data_uri()`
or :py:func:`segno.QRCode.png_data_uri()` methods in the template.

.. code-block:: python

    from flask import Flask, render_template
    import segno

    app = Flask(__name__)

    @app.route('/)
    def home():
        qrcode = segno.make('The Continuing Story of Bungalow Bill')
        return render_template('example.html', qrcode=qrcode)



.. code-block:: jinja

    <!DOCTYPE html>
    <html>
      <head>
        <meta charset="utf-8" />
        <title>QR Codes</title>
      </head>
      <body>
        <img src="{{ qrcode.png_data_uri(dark='darkblue', data_dark='steelblue', alignment_dark='darkgreen', scale=3) }}"><br>
        <img src="{{ qrcode.svg_data_uri(dark='darkblue', scale=4) }}">
      </body>
    </html>


Embed SVG QR codes into HTML
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Since HTML5 supports SVG directly, it's also possible to embed the
generated SVG directly into a template.

Create the QR code within the Flask view and use the
:py:func:`segno.QRCode.svg_inline()` method in conjunction with the Jinja
``|safe`` filter.

.. code-block:: python

    @app.route('/')
    def home():
        qrcode = segno.make('While My Guitar Gently Weeps')
        return render_template('example.html', qrcode=qrcode)

.. code-block:: jinja

    <div>
      {{ qrcode.svg_inline(scale=3) | safe }}
    </div>


Create a view
~~~~~~~~~~~~~

Another possibility is to create the QR codes dynamically in a Flask view and
deliver them with ``send_file``.

.. code-block:: python

    BEATLES_SONGS = {'Yellow Submarine', 'Let It Be', 'Rocky Raccoon'}

    @app.route('/qr-png/')
    def qrcode_png():
        data = request.args.get('data')
        # Check if the data is acceptable otherwise a 404 error is generated
        if data not in BEATLES_SONGS:
            return abort(404)
        buff = io.BytesIO()
        segno.make(data, micro=False) \
             .save(buff, kind='png', scale=4, dark='darkblue',
                   data_dark='#474747', light='#efefef')
        buff.seek(0)
        return send_file(buff, mimetype='image/png')


.. code-block:: jinja

    <img src="{{ url_for('qrcode_png', data='Rocky Raccoon') }}">


Django
------

The project `django-segno-qr <https://pypi.org/project/django-segno-qr/>`_
provides a template tag for creating SVG QR codes in Django templates while
`django-qr-code <https://pypi.org/project/django-qr-code/>`_ provides more
template tags and utility functions.

Apart from that, the aforementioned information for Flask should also be
adaptable to Django, so here is just a hint on how to save QR codes in a
Django ``ImageField``.

The complete code is in the repository:
https://github.com/heuer/segno/tree/master/examples/django_qrcode


Saving a QR code to an ImageField
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Assuming this simple model.

.. code-block:: python

    from django.db import models


    class Ticket(models.Model):
        name = models.CharField(max_length=150, unique=True)
        qrcode = models.ImageField(upload_to='ticket-qrcodes/')

Create a QR code with Segno and save it as PNG into a :py:class:`io.BytesIO`
instance.

.. code-block:: python

    import io
    import segno

    qrcode = segno.make('JULIA')
    # Save the QR code with transparent background and use dark blue for
    # the dark modules
    out = io.BytesIO()
    qrcode.save(out, kind='png', dark='#00008b', light=None, scale=3)

Now you can use the content of the buffer as input for a Django ``ContentFile``.

.. code-block:: python

    ticket = Ticket(name='JULIA')
    ticket.qrcode.save('JULIA.png', ContentFile(out.getvalue()), save=False)
    ticket.save()

If for some reason the QR codes should be stored in the lossy file format JPEG,
the ``qrcode-artistic`` plugin is required (see also :doc:`artistic-qrcodes`)::

    $ pip install qrcode-artistic


.. code-block:: python

    import io
    import segno

    qrcode = segno.make('JULIA')
    # img is a Pillow Image instance
    img = qrcode.to_pil(dark='#00008b', scale=3)
    # Now use Pillow Image.save() to save the QR code
    out = io.BytesIO()
    img.save(out, format='jpg')

    # ...

    ticket.qrcode.save('JULIA.jpg', ContentFile(out.getvalue()), save=False)