Go to file
dependabot[bot] e72ebc7986
Bump actions/setup-python from 4.6.0 to 4.6.1 (#526)
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4.6.0 to 4.6.1.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v4.6.0...v4.6.1)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-25 14:03:26 +02:00
.github Bump actions/setup-python from 4.6.0 to 4.6.1 (#526) 2023-05-25 14:03:26 +02:00
.vscode adapt confDir config for sphinx integration 2023-04-19 20:37:08 +02:00
capabilities-data@1bf6a482bd housekeeping: fix-build for doc (#515) 2023-05-11 23:12:46 +02:00
doc Bump sphinx-rtd-theme from 1.2.0 to 1.2.1 (#524) 2023-05-23 15:22:50 +02:00
examples Added example with Docker and Flask (#519) 2023-05-18 15:06:06 +02:00
src/escpos Add support for slip/cheque dot matrix printers (#485) 2023-05-09 01:25:48 +02:00
test fixed formatting with black 2023-04-19 22:23:23 +02:00
.coveragerc Enable branch coverage. 2016-08-30 18:00:06 +02:00
.gitignore Merge branch 'master' into development 2022-08-28 21:45:21 +02:00
.gitmodules Modified submodule to always pull from master branch (#283) 2018-05-13 18:42:07 +02:00
.mailmap Add Chinese support (#356) 2023-05-09 01:18:00 +02:00
.readthedocs.yml update read the docs config (#520) 2023-05-18 16:33:20 +02:00
AUTHORS Add support for slip/cheque dot matrix printers (#485) 2023-05-09 01:25:48 +02:00
CHANGELOG.rst add changelog (#516) 2023-05-11 23:37:09 +02:00
CONTRIBUTING.rst update read the docs config (#520) 2023-05-18 16:33:20 +02:00
INSTALL update installation information 2019-08-08 11:00:27 +02:00
LICENSE change license to MIT 2017-01-31 03:55:50 +01:00
MANIFEST.in add capabilities to manifest 2020-05-09 00:37:35 +02:00
README.rst remove unused badges (#522) 2023-05-18 16:38:40 +02:00
codecov.yml disable codecov status 2020-05-10 12:35:36 +02:00
pyproject.toml add config for black 2021-10-30 18:14:59 +02:00
requirements.txt ADD requirements.txt and requirements to setup.py 2015-11-27 23:13:48 +01:00
setup.cfg py311 in tests 2023-04-19 22:15:47 +02:00
setup.py drop Python 2.7 support 2020-05-10 10:55:44 +02:00
tox.ini fix passenv 2023-04-19 22:18:25 +02:00

README.rst

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

.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=latest
    :target: https://python-escpos.readthedocs.io/en/latest/?badge=latest
    :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
* `python-barcode <https://github.com/WhyNotHugo/python-barcode>`_ 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()


Another example based on the Network printer class:

.. code:: python

    from escpos.printer import Network

    kitchen = Network("192.168.1.100") #Printer IP Address
    kitchen.text("Hello World\n")
    kitchen.barcode('1324354657687', 'EAN13', 64, 2, '', '')
    kitchen.cut()

Another example based on the Serial printer class:

.. code:: python

    from escpos.printer import Serial

    """ 9600 Baud, 8N1, Flow Control Enabled """
    p = Serial(devfile='/dev/tty.usbserial',
               baudrate=9600,
               bytesize=8,
               parity='N',
               stopbits=1,
               timeout=1.00,
               dsrdtr=True)

    p.text("Hello World\n")
    p.qr("You can readme from your smartphone")
    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 <https://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.