python-escpos/README.rst

72 lines
2.4 KiB
ReStructuredText
Raw Normal View History

2016-03-08 14:47:40 +00:00
#############################################################
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
2016-03-08 14:47:40 +00:00
.. image:: https://readthedocs.org/projects/python-escpos/badge/?version=stable
:target: http://python-escpos.readthedocs.io/en/latest/?badge=stable
2016-03-08 14:47:40 +00:00
: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.
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
2016-03-08 14:47:40 +00:00
""" Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """
p = Usb(0x04b8,0x0202,0)
p.text("Hello World\n")
p.image("logo.gif")
p.barcode('1324354657687','EAN13',64,2,'','')
p.cut()
2016-03-08 14:47:40 +00:00
The full project-documentation is available on `Read the Docs <https://python-escpos.readthedocs.io>`_.
2016-03-08 14:47:40 +00:00
Contributing
------------
This project is open for any contribution! Please see CONTRIBUTING.rst for more information.