Go to file
Patrick Kanzler 3ee787e8b1
change license to MIT
2017-01-31 03:55:50 +01:00
.github add version-strings into the module 2016-07-17 19:39:42 +02:00
capabilities-data@31d2269651 Update escpos-printer-db to include TM-T88II fixes 2016-09-17 18:59:31 +10:00
doc doc update modules in autogeneration 2017-01-29 22:33:15 +01:00
examples use print function in example 2017-01-30 03:00:23 +01:00
src/escpos change license to MIT 2017-01-31 03:55:50 +01:00
test change license to MIT 2017-01-31 03:55:50 +01:00
.coveragerc Enable branch coverage. 2016-08-30 18:00:06 +02:00
.gitignore improve import capabilities from a submodule 2016-09-02 17:13:38 +02:00
.gitmodules update printer DB submodule path 2016-09-09 18:26:25 +10:00
.travis.yml add python36 to travis 2017-01-31 03:29:14 +01:00
CHANGELOG.rst link to escpos-printer-db 2017-01-29 23:20:11 +01:00
CONTRIBUTING.rst update contributing.rst on resolving issues 2016-09-06 23:15:54 +02:00
INSTALL Updated installation instructions 2013-03-13 23:25:46 -07:00
LICENSE change license to MIT 2017-01-31 03:55:50 +01:00
MANIFEST.in change license to MIT 2017-01-31 03:55:50 +01:00
README.rst link to escpos-printer-db 2017-01-29 23:20:11 +01:00
codecov.yml configure codecov.io 2016-08-02 00:10:39 +02:00
readthedocs.yml configure readthedocs with yml 2016-08-02 18:39:56 +02:00
requirements.txt ADD requirements.txt and requirements to setup.py 2015-11-27 23:13:48 +01:00
setup.cfg add flake8-checks to travis 2017-01-30 02:29:08 +01:00
setup.py change license to MIT 2017-01-31 03:55:50 +01:00
tox.ini add notice that we could add flake8-docstrings once 2017-01-30 02:44:26 +01:00

README.rst

#############################################################
python-escpos - Python library to manipulate ESC/POS Printers
#############################################################

.. image:: https://travis-ci.org/python-escpos/python-escpos.svg?branch=master
    :target: https://travis-ci.org/python-escpos/python-escpos
    :alt: Continous Integration

.. image:: https://www.quantifiedcode.com/api/v1/project/95748b89a3974700800b85e4ed3d32c4/badge.svg
    :target: https://www.quantifiedcode.com/app/project/95748b89a3974700800b85e4ed3d32c4
    :alt: Code issues

.. image:: https://landscape.io/github/python-escpos/python-escpos/master/landscape.svg?style=flat
    :target: https://landscape.io/github/python-escpos/python-escpos/master
    :alt: Code Health

.. image:: https://codecov.io/github/python-escpos/python-escpos/coverage.svg?branch=master
    :target: https://codecov.io/github/python-escpos/python-escpos?branch=master
    :alt: Code Coverage

.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=stable
    :target: http://python-escpos.readthedocs.io/en/latest/?badge=stable
    :alt: Documentation Status


Description
-----------

Python ESC/POS is a library which lets the user have access to all those printers handled
by ESC/POS commands, as defined by Epson, from a Python application.

The library tries to implement the functions provided by the ESC/POS-commandset and supports sending text, images,
barcodes and qr-codes to the printer.

Text can be aligned/justified and fonts can be changed by size, type and weight.

Also, this module handles some hardware functionalities like cutting paper, control characters, printer reset
and similar functions.

Since supported commands differ from printer to printer the software tries to automatically apply the right
settings for the printer that you set. These settings are handled by
`escpos-printer-db <https://github.com/receipt-print-hq/escpos-printer-db>`_ which is also used in
`escpos-php <https://github.com/mike42/escpos-php>`_.

Dependencies
------------

This library makes use of:

    * pyusb for USB-printers
    * Pillow for image printing
    * qrcode for the generation of QR-codes
    * pyserial for serial printers

Documentation and Usage
-----------------------

The basic usage is:

.. code:: python

    from escpos.printer import Usb

    """ Seiko Epson Corp. Receipt Printer (EPSON TM-T88III) """
    p = Usb(0x04b8, 0x0202, 0, profile="TM-T88III")
    p.text("Hello World\n")
    p.image("logo.gif")
    p.barcode('1324354657687', 'EAN13', 64, 2, '', '')
    p.cut()

The full project-documentation is available on `Read the Docs <https://python-escpos.readthedocs.io>`_.

Contributing
------------

This project is open for any contribution! Please see CONTRIBUTING.rst for more information.