Skip to content

docs: clarify python-escpos package name #735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Mirochill wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs: clarify python-escpos package name #735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Changelog
changes
^^^^^^^

- document that the package should be installed as ``python-escpos``, not the
unrelated ``escpos`` package

contributors
^^^^^^^^^^^^
Expand Down
10 changes: 10 additions & 0 deletions doc/user/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ always install from PyPi.
If you use the ``--pre`` parameter for ``pip``, you will get the latest
pre-release.

.. note::

The PyPI package name is ``python-escpos``. The unrelated and discontinued
package named ``escpos`` uses the same ``escpos`` import namespace and can
shadow python-escpos if both are installed in the same environment. If an
import such as ``from escpos.printer import Usb`` fails with
``ImportError: cannot import name 'DeviceNotFoundError' from
'escpos.exceptions'``, remove the ``escpos`` package and reinstall
``python-escpos`` in a clean environment.

The following installation options exist:

* `all`: install all packages available for this platform
Expand Down