Metadata-Version: 1.1
Name: treepoem
Version: 1.3.2
Summary: Barcode rendering for Python 2 and 3 supporting QRcode, Aztec, PDF417, I25, Code128, Code39 and many more types.
Home-page: https://github.com/YPlan/treepoem
Author: Julius Seporaitis
Author-email: julius@yplanapp.com
License: MIT
Description: ========
        Treepoem
        ========
        
        .. image:: https://img.shields.io/pypi/v/treepoem.svg
                   :target: https://pypi.python.org/pypi/treepoem
        
        .. image:: https://img.shields.io/travis/YPlan/treepoem.svg
                   :target: https://travis-ci.org/YPlan/treepoem
        
        
        A cleverly named, but very simple python barcode renderer wrapping the
        BWIPP_ library and ``ghostscript`` command line tool, Python 2.7 and 3.3+
        compatible.
        
        ------------
        Installation
        ------------
        
        Install from **pip**:
        
        .. code-block:: sh
        
            pip install treepoem
        
        You'll also need Ghostscript installed. On Ubuntu/Debian this can be installed
        with:
        
        .. code-block:: sh
        
            apt-get install ghostscript
        
        On Mac OS X use:
        
        .. code-block:: sh
        
            brew install ghostscript
        
        Otherwise refer to your distribution's package manager, though it's likely to
        be called ``ghostscript`` too.
        
        ---
        API
        ---
        
        ``generate_barcode(barcode_type, data, options)``
        -------------------------------------------------
        
        Generates a barcode and returns it as a PIL image file object (specifically, a
        ``PIL.EpsImagePlugin.EpsImageFile``).
        
        ``barcode_type`` is the name of the barcode type to generate (see below).
        
        ``data`` is the string of data to embed in the barcode - the amount that can be
        embedded varies by type.
        
        ``options`` is a dictionary of strings-to-strings of extra options to be passed
        to BWIPP_, as per its docs.
        
        For example, this generates a QR code image, and saves it to a file using
        standard PIL ``Image.save()``:
        
        .. code-block:: python
        
           >>> import treepoem
           >>> image = treepoem.generate_barcode(
           ...     barcode_type='qrcode',  # One of the BWIPP supported codes.
           ...     data='barcode payload',
           ...     options={},
           ... )
           >>> image.save('barcode.png')
        
        
        ``barcode_types``
        -----------------
        
        This is a set of the ~100 names of the barcode types that the vendored version
        of BWIPP_ supports. If you're looking for whether a specific type is supported,
        check here.
        
        The library is tested with these specific, common types:
        
        * ``qrcode`` - `QR Code`_
        
        * ``azteccode`` - `Aztec Code`_
        
        * ``pdf417`` - PDF417_
        
        * ``interleaved2of5`` - `Interleaved 2 of 5`_
        
        * ``code128`` - `Code 128`_
        
        * ``code39`` - `Code 39`_
        
        --------------------------------
        What's so clever about the name?
        --------------------------------
        
        Barcode.
        
        Bark ode.
        
        Tree poem.
        
        
        .. _BWIPP: https://github.com/bwipp/postscriptbarcode
        .. _QR Code: https://github.com/bwipp/postscriptbarcode/wiki/QR-Code
        .. _Aztec Code: https://github.com/bwipp/postscriptbarcode/wiki/Aztec-Code
        .. _PDF417: https://github.com/bwipp/postscriptbarcode/wiki/PDF417
        .. _Interleaved 2 of 5: https://github.com/bwipp/postscriptbarcode/wiki/Interleaved-2-of-5
        .. _Code 128: https://github.com/bwipp/postscriptbarcode/wiki/Code-128
        .. _Code 39: https://github.com/bwipp/postscriptbarcode/wiki/Code-39
        
        
        
        
        -------
        History
        -------
        
        .. Insert new release notes below this line
        
        1.3.2 (2017-10-22)
        ------------------
        
        * Upgrade BWIPP from 2017-07-10 to 2017-10-19. This has a few bug fixes. You
          can read its changelog in the vendored copy in the `treepoem repo
          <https://github.com/YPlan/treepoem/blob/master/treepoem/postscriptbarcode/CHANGES>`__.
        
        1.3.1 (2017-08-24)
        ------------------
        
        * Upgrade BWIPP from 2017-06-20 to 2017-07-10. This has a few bug fixes. You
          can read its changelog in the vendored copy in the `treepoem repo
          <https://github.com/YPlan/treepoem/blob/master/treepoem/postscriptbarcode/CHANGES>`__.
        
        1.3.0 (2017-06-21)
        ------------------
        
        * Upgrade BWIPP from 2015-11-24 to 2017-06-20. This has a number of bug fixes,
          and supports more barcode types. It has also changed the pixel-for-pixel
          output of some formats, although they still encode the same information -
          notably QR codes, which are tested in ``treepoem``\'s test suite. You can
          read its changelog in the `vendored copy in the treepoem repo
          <https://github.com/YPlan/treepoem/blob/master/treepoem/postscriptbarcode/CHANGES>`__.
        
        1.2.0 (2017-06-21)
        ------------------
        
        * Add ``treepoem.barcode_types``, a set of all the names of supported barcode
          types, and error if asked to generate a barcode of an unknown type.
        
        1.1.0 (2017-04-13)
        ------------------
        
        * Support Windows.
        
        1.0.1 (2016-03-30)
        ------------------
        
        * Add the missing ``BWIPP`` files.
        
        1.0.0 (2016-03-23)
        ------------------
        
        * Use ``$PATH`` to find ``gs`` binary.
        * Rename ``PostscriptError`` to ``TreepoemError``.
        * Add basic ``setup.py``.
        * Setup Travis CI build.
        * Setup Tox
        
Keywords: b,a,r,c,o,d,e, ,b,w,i,p,p, ,p,o,s,t,s,c,r,i,p,t, ,g,h,o,s,t,s,c,r,i,p,t, ,q,r, ,q,r,c,o,d,e, ,a,z,t,e,c, ,a,z,t,e,c,c,o,d,e, ,p,d,f,4,1,7, ,i,n,t,e,r,l,e,a,v,e,d,2,o,f,5, ,i,2,5, ,c,o,d,e,1,2,8, ,c,o,d,e,3,9
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
