Skip to content

docs: clarify python-escpos package name#735

Draft
Mirochill wants to merge 1 commit into
python-escpos:masterfrom
Mirochill:docs-629-install-package-name
Draft

docs: clarify python-escpos package name#735
Mirochill wants to merge 1 commit into
python-escpos:masterfrom
Mirochill:docs-629-install-package-name

Conversation

@Mirochill

Copy link
Copy Markdown

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!

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.

2 participants