setop/python-escpos
1
0
Fork 0
mirror of https://github.com/python-escpos/python-escpos synced 2025-10-23 09:30:00 +00:00
Code Activity

DOC update documentation on installation and CLI

Browse Source
This commit is contained in:
Patrick Kanzler
2016-07-23 11:34:18 +02:00
parent 80b714fdae
commit fd3f1067fe
3 changed files with 25 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/user/installation.rst
View File

@@ -2,16 +2,26 @@
Installation
************
System preparation
------------------
:Last Reviewed: 2016-07-23
1. Install the required
`dependencies <https://github.com/manpaz/python-escpos/wiki/Dependencies>`__
Installation with PIP
---------------------
Installation should be rather straight-forward. python-escpos is on PyPi, so you can simply enter:
2. Get the *Product ID* and *Vendor ID* from the lsusb command
::
pip install python-escpos
This should install all necessary dependencies. Apart from that python-escpos should also be
available as a Debian package. If you want to always benefit from the newest stable releases you should probably
install from PyPi.
Setup udev for USB-Printers
---------------------------
1. Get the *Product ID* and *Vendor ID* from the lsusb command
``# lsusb Bus 002 Device 001: ID 1a2b:1a2b Device name``
3. Create a udev rule to let users belonging to *dialout* group use the
2. Create a udev rule to let users belonging to *dialout* group use the
printer. You can create the file
``/etc/udev/rules.d/99-escpos.rules`` and add the following:
``SUBSYSTEM=="usb", ATTRS{idVendor}=="1a2b", ATTRS{idProduct}=="1a2b", MODE="0664", GROUP="dialout"``
@@ -20,21 +30,19 @@ System preparation
"dialout" group, or use another group you already belongs instead
"dialout" and set it in the ``GROUP`` parameter in the above rule.
4. Restart udev ``# sudo service udev restart`` In some new systems it
3. Restart udev ``# sudo service udev restart`` In some new systems it
is done with ``# sudo udevadm control --reload``
Install
-------
Enabling tab-completion in CLI
------------------------------
python-escpos has a CLI with tab-completion. This is realised with ``argcomplete``.
In order for this to work you have to enable tab-completion, which is described in
the `manual of argcomplete <https://argcomplete.readthedocs.io>`__.
* Clone python-escpos from github
* Change directory to python-escpos and install the package
If you only want to enable it for python-escpos, or global activation does not work, try this:
::
::
# cd python-escpos
# python setup.py build
# sudo python setup.py install
* Enjoy !!!
eval "$(register-python-argcomplete python-escpos)"