setop
/
python-escpos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
286 Commits 9 Branches 22 Tags 2.3 MiB
Python 100%
Go to file
Patrick Kanzler 9f5eed0020
add version-strings into the module 
The version string is in the module as __version__ available.
In the doc the version will be automatically parsed. The version comes
from the installed module if on read the docs or directly from
setuptools_scm if you are working locally.
The CLI will issue the version string if you call it with the option
'version'. The CLI does not accept commands like '--version', since this
would not be conform with the rest of the interface (and argparse).

The configuration for loading the version-string is adapted from
pimutils/vdirsyncer. It autogenerates a version string setuptools_scm at
install-time and then adds it to the __version__ member in __init__.py

I adapted the GitHub-template with a fitting comment and bumped the
changelog.

closes #141
 		2016-07-17 19:39:42 +02:00
.github add version-strings into the module 2016-07-17 19:39:42 +02:00
doc add version-strings into the module 2016-07-17 19:39:42 +02:00
src/escpos add version-strings into the module 2016-07-17 19:39:42 +02:00
test add version-strings into the module 2016-07-17 19:39:42 +02:00
.gitignore add version-strings into the module 2016-07-17 19:39:42 +02:00
.travis.yml SETUP move code to src 2016-06-20 17:48:14 +02:00
CHANGELOG.rst add version-strings into the module 2016-07-17 19:39:42 +02:00
CONTRIBUTING.rst DOC improve CONTRIBUTING 2016-04-14 00:16:06 +02:00
COPYING Initial files 2010-02-26 00:54:46 -08:00
INSTALL Updated installation instructions 2013-03-13 23:25:46 -07:00
MANIFEST.in PCKG fix setup.py and improve Manifest 2016-03-11 14:46:36 +01:00
README.rst Converted references to readthedocs.org -> readthedocs.io. Resolves python-escpos/python-escpos#132 2016-04-30 23:22:14 +10:00
codecov.yml configure codecov.io 2016-06-26 20:39:06 +02:00
requirements.txt ADD requirements.txt and requirements to setup.py 2015-11-27 23:13:48 +01:00
setup.cfg SETUP enable build of universal wheels 2016-03-08 20:07:16 +01:00
setup.py add version-strings into the module 2016-07-17 19:39:42 +02:00
tox.ini SETUP move code to src 2016-06-20 17:48:14 +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://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.

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 import *

    """ Seiko Epson Corp. Receipt Printer M129 Definitions (EPSON TM-T88IV) """
    Epson = escpos.Escpos(0x04b8,0x0202,0)
    Epson.text("Hello World\n")
    Epson.image("logo.gif")
    Epson.barcode('1324354657687','EAN13',64,2,'','')
    Epson.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.