Metadata-Version: 1.1
Name: segno
Version: 0.1.2
Summary: QR Code and Micro QR Code generator for Python 2 and Python 3
Home-page: https://github.com/heuer/segno/
Author: Lars Heuer
Author-email: heuer@semagia.com
License: BSD
Description: Segno -- Python QR Code and Micro QR Code generator
        ===================================================
        
        Segno is a QR Code and Micro QR Code generator which has no further
        dependencies.
        
        This package implements main parts of ISO/IEC 18004:2006(E) / ISO/IEC 18004:2015(E)
        and produces Micro QR Codes and QR Codes with nearly no effort.
        
        Segno provides several serialization formats like SVG, EPS, PNG, PDF, or text
        output. None of these serializers require an external lib. Segno provides
        more serialization formats via a plugin architecture. It was tested against
        Python 2.6 - 3.4 and PyPy.
        
        
        Installation
        ------------
        
        Use ``pip`` to install segno from PyPI::
        
            $ pip install segno
        
        
        Usage
        -----
        
        Segno provides several, specific methods which serialize the QR Code (like
        ``svg``, ``png``), but it also provides a general ``save()`` method which could
        be used to save a QR Code in the desired format.
        
        .. code-block:: python
        
            >>> import segno
            >>> qr = segno.make('Up Jumped the Devil')  # Let Segno choose the minimal version
            >>> qr.is_micro
            False
            >>> qr.version
            2
            >>> qr.error
            'M'
            >>> qr.save('up-jumped-the-devil.png')  # Save as PNG
            >>> qr.save('up-jumped-the-devil-2.png', scale=10)  # Scaling factor 10
            >>> qr.save('up-jumped-the-devil-3.png', background=None)  # Transparent background
            >>> qr.save('up-jumped-the-devil.pdf', scale=10)  # Save as PDF
            >>> # SVG drawing the dark modules in "dark blue"
            >>> qr.save('up-jumped-the-devil.svg', scale=10, color='darkblue')
        
        
        If the content to encode is small enough, a Micro QR Code is generated:
        
        .. code-block:: python
        
            >>> import segno
            >>> qr = segno.make('RAIN')
            >>> qr.is_micro
            True
            >>> qr.version
            'M2'
        
        
        If this behaviour is not desired, the user may use the factory functions
        ``segno.make_qr()`` which generates always QR Codes (never Micro QR Codes) or
        ``segno.make_micro()`` which generates always Micro QR Codes (or raises an error
        if the content is too large for a Micro QR Code).
        
        .. code-block:: python
        
            >>> import segno
            >>> mqr = segno.make_micro('THE BEATLES')
            >>> mqr.version
            'M3'
            >>> qr = segno.make_qr('THE BEATLES')  # Same content but enforce a QR Code
            >>> qr.version
            1
            >>> # This won't work since the data does not fit into a Micro QR Code M1 - M4
            >>> mqr = 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.
        
        
        Other QR Code generators
        ------------------------
        * <https://pypi.python.org/pypi/PyQRCode/>
        * <https://pypi.python.org/pypi/qrcode/>
        * <https://pypi.python.org/pypi/qrcodegen/>
        
        .. _Segno's documentation: http://segno.readthedocs.io/en/latest/
        
        Changes
        =======
        
        0.1.2 -- 2016-08-17
        -------------------
        * Updated docs
        * Backwards incompatible change: Deprecated "eps", "svg", "png", "pdf", and
          "txt" methods from QRCode. Use QRCode.save.
          Methods will be removed in 0.1.3
        * Fixed issue #3 (M1 and M3 codes may have undefined areas)
        * Fixed issue #4 (wrong 'error' default value for encoder.encode(),
          factory function segno.make() wasn't affected)
        
        
        0.1.1 -- 2016-08-14
        -------------------
        * Initial release
        
Keywords: QR Code,Micro QR Code,ISO/IEC 18004,ISO/IEC 18004:2006(E),ISO/IEC 18004:2015(E)
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Printing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
