Go to file
Patrick Kanzler 44f01a212b fix docs failing due to pickle protocol in mixed env
When executing a tox-run a pickle file will be created. If the docs are
built after the py3 task, it will fail due to incompatible
pickle-protocols.
See https://stackoverflow.com/a/25843743/4244236 for reference.
2017-10-08 21:08:13 +02:00
.github add version-strings into the module 2016-07-17 19:39:42 +02:00
capabilities-data@fd207aa9de Updated capabilities data to new version 2017-03-29 15:24:36 +02:00
doc tell sort to ignore case 2017-08-31 13:43:07 +02:00
examples First attempt at centering images and QRs (#250) 2017-08-31 09:25:35 +02:00
src/escpos fix docs failing due to pickle protocol in mixed env 2017-10-08 21:08:13 +02:00
test Feature/check barcodes (#255) 2017-10-08 20:05:18 +02:00
.coveragerc Enable branch coverage. 2016-08-30 18:00:06 +02:00
.gitignore Handle cases when fullCut or partCut not available 2017-03-29 15:24:25 +02:00
.gitmodules update printer DB submodule path 2016-09-09 18:26:25 +10:00
.mailmap Fixed outdated example file: should be font 'b' not 'B' 2017-08-31 08:38:32 +02:00
.travis.yml integrate author check into travis 2017-05-26 02:36:16 +02:00
AUTHORS Feature/check barcodes (#255) 2017-10-08 20:05:18 +02:00
CHANGELOG.rst update changelog for next release 2017-08-04 16:30:31 +02:00
CONTRIBUTING.rst update contributing 2017-08-08 13:37:30 +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 update README 2017-08-08 13:30:16 +02:00
codecov.yml remove patch-coverage because we don't use it 2017-03-23 15:35:32 +01: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 completely fix tests 2017-09-27 10:38:42 +02:00
tox.ini completely fix tests 2017-09-27 10:38:42 +02: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://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 <https://github.com/walac/pyusb>`_ for USB-printers
* `Pillow <https://github.com/python-pillow/Pillow>`_ for image printing
* `qrcode <https://github.com/lincolnloop/python-qrcode>`_ for the generation of QR-codes
* `pyserial <https://github.com/pyserial/pyserial>`_ for serial printers
* `viivakoodi <https://github.com/kxepal/viivakoodi>`_ for the generation of barcodes

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 <http://python-escpos.readthedocs.io/en/latest/dev/contributing.html>`_ for more information.


Disclaimer
----------

None of the vendors cited in this project agree or endorse any of the patterns or implementations.
Its names are used only to maintain context.