Skip to main content

QR Code and Micro QR Code generator for Python

Project description

Pure Python QR Code generator with no dependencies.

This package implements ISO/IEC 18004:2015(E) “QR Code bar code symbology specification” and produces QR Codes and Micro QR Codes with nearly no effort. It supports the Structured Append mode which splits a message across several QR codes.

Segno (Italian for “sign” / “symbol”) provides several serialization formats like Scalable Vector Graphics (SVG), Encapsulated PostScript (EPS), Portable Network Graphics (PNG), Portable Document Format (PDF), Netpbm (PAM, PBM, PPM), LaTeX (PGF/TikZ), X PixMap (XBM), and X Bitmap (XPM) etc. None of these serializers require an external lib. Further, it provides several high level functions to create QR Codes which encode contact data (vCard, MeCard), EPC QR Codes, or WIFI QR Codes.

The project provides more than 1500 test cases (coverage >= 98%) to verify a standard conform QR Code and Micro QR Code generation acc. to ISO/IEC 18004:2015(E).

Unique features

import segno
qrcode = segno.make('Yellow Submarine')
qrcode.save('yellow-submarine.png')

Installation

Use pip to install segno from PyPI:

$ pip install segno

conda-forge

The library is also available at conda-forge (conda-forge project page):

$ conda install -c conda-forge segno

Debian

$ apt-get install python3-segno

Arch Linux

$ pacman -S python-segno

Usage

Command line

The command line script prints a QR code to the terminal:

$ segno "Comfortably Numb"

To serialize a QR code, use the “output” argument:

$ segno -o=raincoat.svg "Famous Blue Raincoat"
$ segno --scale 10 --dark darkblue --border 0 --output=fire.svg "Who by Fire"
$ segno --scale 10 --light transparent --output=miracle.png "Waiting for the Miracle"

Library

>>> import segno
>>> # Let Segno choose the minimal version and an optimal (maximal) error
>>> # level without changing the minimal version
>>> qrcode = segno.make('Up Jumped the Devil')
>>> qrcode.designator  # Returns the QR code version and the error correction level
'2-Q'
>>> qrcode.save('up-jumped-the-devil.png')  # Save as PNG
>>> qrcode.save('up-jumped-the-devil-2.png', scale=10)  # Scaling factor 10
>>> qrcode.save('up-jumped-the-devil-3.png', light=None)  # Transparent light modules
>>> qrcode.save('up-jumped-the-devil.pdf', scale=10)  # Save as PDF
>>> # SVG drawing the dark modules in "dark blue"
>>> qrcode.save('up-jumped-the-devil.svg', scale=10, dark='darkblue')

If the content to encode is small enough, a Micro QR code is generated:

>>> import segno
>>> qrcode = segno.make('RAIN')
>>> qrcode.is_micro
True
>>> qrcode.designator
'M2-M'

If this behaviour is not desired, the user may set micro to False

>>> import segno
>>> qrcode = segno.make('RAIN', micro=False)
>>> qrcode.is_micro
False
>>> qrcode.designator
'1-H'

Or use the factory functions segno.make_qr() which generates always QR codes (never Micro QR codes) or segno.make_micro() which returns always Micro QR codes (or raises an error if the content is too large for a Micro QR code).

>>> import segno
>>> qrcode_micro = segno.make_micro('THE BEATLES')
>>> qrcode_micro.designator
'M3-M'
>>> qrcode = segno.make_qr('THE BEATLES')  # Same content but enforce a QR Code
>>> qrcode.designator
'1-Q'
>>> # This won't work since the data does not fit into a Micro QR Code M1 - M4
>>> micro_qrcode = segno.make_micro('Nick Cave and the Bad Seeds')
Traceback (most recent call last):
    ...
DataOverflowError: Data too large. No Micro QR Code can handle the provided data

All factory functions use the same parameters to specify the desired error level, version, data mask etc., see Segno’s documentation for details.

Documentation

Read the online documentation at <https://segno.readthedocs.io/>

Trademark

“QR Code” and “Micro QR Code” are registered trademarks of DENSO WAVE INCORPORATED.

Project details


Download files

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

Source Distribution

segno-1.6.6.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

segno-1.6.6-py3-none-any.whl (76.5 kB view details)

Uploaded Python 3

File details

Details for the file segno-1.6.6.tar.gz.

File metadata

  • Download URL: segno-1.6.6.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for segno-1.6.6.tar.gz
Algorithm Hash digest
SHA256 e60933afc4b52137d323a4434c8340e0ce1e58cec71439e46680d4db188f11b3
MD5 088bb1d2ec7f279e91cd3a8936ef7d3d
BLAKE2b-256 1c2eb396f750c53f570055bf5a9fc1ace09bed2dff013c73b7afec5702a581ba

See more details on using hashes here.

File details

Details for the file segno-1.6.6-py3-none-any.whl.

File metadata

  • Download URL: segno-1.6.6-py3-none-any.whl
  • Upload date:
  • Size: 76.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for segno-1.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 28c7d081ed0cf935e0411293a465efd4d500704072cdb039778a2ab8736190c7
MD5 ce237bf6228ee80495d42ff75faaee38
BLAKE2b-256 d60212c73fd423eb9577b97fc1924966b929eff7074ae6b2e15dd3d30cb9e4ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page