Commit Graph

49 Commits

Author SHA1 Message Date
Patrick Kanzler ecfeeb9b13
Improve diagnostic output (#577)
* add extended version information

* autodocument argparser

* add spelling exception

* fix docstrings

* add annotations

* use typing types

* add test
2023-10-05 14:15:19 +02:00
Patrick Kanzler cfa9ecf16d
Enable spell checking (#563)
* add spellchecking

* improve spelling

* improve spelling config

* extend word list

* improve spelling

* improve spelling

* escalate warning in spell check to failure

* fix spelling

* fix spelling

* add plural

* Update doc/spelling_wordlist.txt

* do not stop on warning

* require newest sphinxcontrib spelling

* remove old comment

* add authors as single line entry to spelling list

* reenable stop on warning
2023-09-07 22:08:31 +02:00
Patrick Kanzler 24217756f7
558 improve capabilities handling (#562)
* add handling for missing capabilities file

* improve documentation

* Update doc/user/installation.rst
2023-09-06 00:05:38 +02:00
Patrick Kanzler 3177c8d411
split off dependencies for optional installation (#546)
* add inheritance diagrams to all printers and exceptions
* split off printer implementations into separate files
* add wrapper that thros RuntimeError if not importable
* add dependency check for lp
* add dependency check for pyserial
* added check for usability
* import Win32Raw
* include WIn32Raw in documentation
* enable all extras on tox
* update github workflow
2023-08-17 01:37:50 +02:00
Patrick Kanzler 2b62c8e28d
modernize and cleanup documentation (#542)
* disable system packages on rtd

* install pycups on rtd

* enable cups binding in documentation

* document CupsPrinter

* fix formatting

* revise methods and installation

* revise user/printers

* revise raspi section

* further revise
2023-08-10 01:38:47 +02:00
Patrick Kanzler 31daabcbea
Improve documentation build (#539)
* use imgconverter
* enable pdf build with xelatex
* change heading levels
* restructure headings
* add chapter intro
* remove extensions from index
2023-08-09 00:52:01 +02:00
Patrick Kanzler 60c4f481ae
Add printer profile list to documentation (#536)
* add first draft of printer profile listing

* add todos

* Update doc/capability_templates/capabilities-template.jinja

* Update doc/capability_templates/capabilities-template.jinja

* restructure documentation

* add encoding list

* add color and encoding table

* add notes on usage

* add feature table
2023-07-29 02:02:13 +02:00
Patrick Kanzler 09a598883c
351 ean example fix (#537)
* bug/doc: Fix invalid EAN-13 barcode in examples

In the various examples and python-escpos CLI there are a number of uses
of `13243546557687` as an EAN-13 example.  This EAN barcode is invalid
as the checksum should be `0` and not `7`.

```
$ python test_print.py
Traceback (most recent call last):
  File "test_print.py", line 5, in <module>
    p.barcode('13243546557687', 'EAN13', 64, 2, '', '')
  File "/home/pi/fatt-display/lib/python3.7/site-packages/escpos/escpos.py", line 433, in barcode
    bc=bc,
escpos.exceptions.BarcodeCodeError: No Barcode code was supplied (Barcode '13243546557687' not in a valid format for type 'EAN13')
```

This patch set removes `13243546557687` and replaces it with the valid
number `40063813339310`.

In researching the list of [assigned prefixes issued by
G1][g1-prefixes] there seemed to be no "officially" defined test  prefix, so
this change was made to be minimally invasive using the number from the
existing test cases.

Resolves #350

Affects #176

[g1-prefixes]: https://www.gs1.org/standards/id-keys/company-prefix
[test-code]: https://www.barcodelookup.com/4006381333931

---------

Co-authored-by: Brian 'Redbeard' Harrington <redbeard@dead-city.org>
2023-07-28 18:23:18 +02:00
Benito López 3c11c1b9ab
New high level barcode method. Closes #245, #244. (#527)
* Merge software and hardware barcodes to one method

* Fix wrong sw barcode heigh/width

* Add missing param to _sw_barcode call

* Make barcode() smarter, improvements and clean up

* Use param font_size in sw_barcode()

* Update docstrings

* Update barcode examples and docs

* Add --force_software option to CLI

* Attempt to match the sw and hw barcode sizes

* Better approximation to native font size

* Fix docs build

* Update tests at test_function_softbarcode

* Fix exception

* Move image dpi setting to writter_options

* Fix _sw_barcode() docstring param

* Fix wrong default param in docstring

* improve linkage in documentation

---------

Co-authored-by: Patrick Kanzler <4189642+patkan@users.noreply.github.com>
Co-authored-by: Patrick Kanzler <dev@pkanzler.de>
2023-07-12 20:45:41 +02:00
Patrick Kanzler 98ee06a783 preliminarily deactivate cups printer documentation 2023-04-19 22:42:55 +02:00
belono ea61f287cb Add/Improve documentation of the new connectors 2022-12-11 16:29:33 +01:00
Patrick Kanzler a2e348d04a fix typos 2020-10-04 14:30:03 +02:00
Patrick Kanzler 40c8399a68 update documentation on STAR TSP100
fixes #410 and #403
2020-10-04 14:28:09 +02:00
Patrick Kanzler 2d798ca7e5 add hint on proper script names
fixes #404
2020-09-28 19:51:49 +02:00
Patrick Kanzler f4e214ad17 add spellchecker with first conf, fix some errors 2020-05-11 23:39:56 +02:00
Romain Porte cb30d7a881 drop Python 2.7 support
Python 2.7 EOL is arriving on 2020-01-01: https://pythonclock.org/

This will allow us to use Python 3 only libraries, like python-barcode,
which can maintain a reduced, simpler codebase, due to only one version
to support.

Closes #371.

Signed-off-by: Romain Porte <microjoe@microjoe.org>
2020-05-10 10:55:44 +02:00
Alexander Bougakov e350a49cad
Clarify the positions of vendor_id and product_id
An existing example uses same value, `0x1a2b`  in both `Vendor id` and `Product id` fields, which can confuse a new user.
2020-03-22 13:36:49 +03:00
Patrick Kanzler fa140c2df5 cleanup todo page 2019-06-19 15:50:19 +02:00
Patrick Kanzler 29a546821b doc add example for Serial on Windows
fixes #322
2019-06-10 22:05:26 +02:00
Patrick Kanzler 4882c31531 Clarifiy and update usage.rst
relevant to #230
clarifies the config-file  in the usage.rst
2017-06-10 23:35:26 +00:00
Patrick Kanzler 0f33d68f3a
add doc for ESCPOS_CAPABILITIES_FILE 2017-03-27 15:30:14 +02:00
Patrick Kanzler e595bc2150
doc update methods and printers and use autodoc 2017-01-26 00:28:33 +01:00
Asuki Kono 938f9890ab Update doc about installation for raspi (#194)
* Update dec about installation for raspi

* Rollback syntax about warning on raspi doc

* Add a link of installation-manual on raspi doc

* Update last reviewed date for raspi doc
2017-01-05 21:51:07 +01:00
Thijs Triemstra 24731f433e fix typos 2016-12-09 16:56:23 +01:00
Thijs Triemstra 6158ba344f fix typos 2016-12-09 16:42:23 +01:00
Patrick Kanzler bd57c01794
update doc-page on Raspi 2016-12-07 20:31:49 +01:00
ysuolmai da0d49c787 Update raspi.rst 2016-11-25 21:44:47 +11:00
Michael Billington 2c8bc1180d Merge branch 'text-encoding' of https://github.com/miracle2k/python-escpos into miracle2k-text-encoding 2016-09-11 14:19:34 +10:00
Curtis // mashedkeyboard f5c706db34 Extended underline to fit the wording of the new subtitle 2016-09-01 12:10:35 +01:00
Curtis // mashedkeyboard b29ef6df69 Corrected set() command documentation
The documentation currently says that `printer.set(type="B")` is the way to bold text. It won't work - you need to use `printer.set(text_type="B")`.
2016-09-01 11:57:58 +01:00
Michael Elsdörfer f6ce7e45da Merge branch 'capabilities' into text-encoding 2016-08-26 15:29:31 +02:00
Patrick Kanzler 340a47d2f6 Merge pull request #152 from python-escpos/fix/large-image-printing
Fix/large image printing
2016-08-07 12:22:25 +02:00
Patrick Kanzler 38f9835931
fix printing of CODE128
The control sequence {A or {B or {C can't be part of the qr code.
For this the user has to supply this sequence.
2016-08-02 15:39:31 +02:00
Patrick Kanzler 13937ab0da doc update documentation regarding codepages 2016-08-02 04:42:21 +02:00
Patrick Kanzler 7c732ee615
doc fix lists 2016-08-02 04:38:04 +02:00
Patrick Kanzler 10977b06e7
doc add hint on image preprocessing 2016-08-01 14:02:49 +02:00
Patrick Kanzler fd3f1067fe
DOC update documentation on installation and CLI 2016-07-23 11:34:18 +02:00
Patrick Kanzler 57dd60c13f
doc: add troubleshooting hint to network-interface
closes #142
2016-07-15 13:18:33 +02:00
Patrick Kanzler a0dc993f2f
DOC add example on printing commands from binary files 2016-05-01 15:27:15 +02:00
Davis Goglin c26c875b61 Convert ini format to yaml format. 2016-03-28 09:58:42 -07:00
Davis Goglin ef31e58d26 Add base config documentation 2016-03-28 09:58:42 -07:00
davisgoglin d9ffb03089 Update documentation for barcode function type B 2016-03-06 20:25:16 -08:00
Dean Rispin 8d00e63b87 Add width/height multiplier support, upsidedown text and text smoothing 2016-03-01 10:05:52 -08:00
Dean Rispin 7c98de6727 ADD inverted printing to set method 2016-02-29 20:56:45 +01:00
Patrick Kanzler d00fc5016b DOC add a todo directive to the documentation
.. todo:: will create Todos that are listed in the TODO in the documentation
2016-01-14 00:53:44 +01:00
Patrick Kanzler 69680b04e9 DOC added notice on RS232 voltage levels
fixes #41
2016-01-06 12:13:35 +01:00
Patrick Kanzler 8b8ca76af6 DOC improve the documentation
* make API-doc more legible
* improve comments in methods
2016-01-05 23:14:35 +01:00
Patrick Kanzler ce0b0d5ba3 DOC improve documentation
* fixes #73
* links now to readthedocs instead of Wiki
2015-12-27 19:09:31 +01:00
Patrick Kanzler 8a77c963c3 DOC transfered wiki to sphinx-doc
* changed structure of index-file
* copied the WIKI at commit 67601b2d33f5a3cf8e9633e6ad92cca286840680
* adapted the markdown to rst
2015-12-27 19:01:05 +01:00