Go to file
Patrick Kanzler ec454d1ca4
add appveyor configuration
2017-05-26 13:21:50 +02:00
.github add version-strings into the module 2016-07-17 19:39:42 +02:00
appveyor add appveyor configuration 2017-05-26 13:21:50 +02:00
capabilities-data@fd207aa9de Updated capabilities data to new version 2017-03-29 15:24:36 +02:00
doc integrate author check into travis 2017-05-26 02:36:16 +02:00
examples use print function in example 2017-01-30 03:00:23 +01:00
src/escpos Added ImageWidthError and its implementation (#226) 2017-05-23 15:13:28 +02:00
test Added ImageWidthError and its implementation (#226) 2017-05-23 15:13:28 +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 add .mailmap in order to normalize shortlog 2017-05-24 10:23:01 +02:00
.travis.yml integrate author check into travis 2017-05-26 02:36:16 +02:00
AUTHORS Added authors file and generate_authors.sh (#227) 2017-05-26 00:27:17 +02:00
CHANGELOG.rst update changelog 2017-03-29 15:45:06 +02:00
CONTRIBUTING.rst integrate author check into travis 2017-05-26 02:36:16 +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 Lists should not be right-espaced in reST 2017-05-24 23:57:38 +02:00
appveyor.yml add appveyor configuration 2017-05-26 13:21:50 +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 added new trove for 3.6 and 3.7 2017-05-24 10:58:55 +02: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.