Skip to content

docs: clarify python-escpos package name#735

Merged
patkan merged 2 commits into
python-escpos:masterfrom
Mirochill:docs-629-install-package-name
Jul 27, 2026
Merged

docs: clarify python-escpos package name#735
patkan merged 2 commits into
python-escpos:masterfrom
Mirochill:docs-629-install-package-name

Conversation

@Mirochill

Copy link
Copy Markdown
Contributor

Description

Adds an installation note that the PyPI package name is python-escpos, not the unrelated discontinued escpos package. The note explains that installing both can shadow the shared escpos import namespace and produce import errors like the DeviceNotFoundError case reported in #629.

Also adds a changelog entry for the documentation update.

Helps #629.

Tested with

Not run locally; documentation-only change.

Validation:

  • git diff --check
  • git show --check --stat --oneline HEAD
  • rg -n "DeviceNotFoundError|python-escpos|unrelated.*escpos|package named ``escpos``|document that the package" CHANGELOG.rst doc/user/installation.rst

@belono belono left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Mirochill and welcome to python-escpos!

This clarification is very welcome and necessary, as it has been a source of issues for a long time.

You can remove the "Draft" label and leave the pull request open for @patkan to review and merge.

Thanks!

@patkan
patkan marked this pull request as ready for review July 27, 2026 01:19
@patkan
patkan merged commit 9353695 into python-escpos:master Jul 27, 2026
12 of 14 checks passed
@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.70%. Comparing base (58f9f20) to head (4c030f8).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #735   +/-   ##
=======================================
  Coverage   81.70%   81.70%           
=======================================
  Files          21       21           
  Lines        1700     1700           
  Branches      266      266           
=======================================
  Hits         1389     1389           
  Misses        231      231           
  Partials       80       80           
Flag Coverage Δ
unittests 81.64% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants