python-can icon indicating copy to clipboard operation
python-can copied to clipboard

Inconsistency between gs_usb in install instructions and pip

Open trupples opened this issue 11 months ago • 0 comments

Describe the bug

The current docs instruct you to run pip install "python-can[gs_usb]" for gs_usb support. On the pypi registry, the extra is named gs-usb (hyphen instead of underscore).

https://github.com/hardbyte/python-can/blob/654a02ae24bfc50bf1bb1fad7aab4aa88763d302/doc/interfaces/gs_usb.rst?plain=1#L9

https://pypi.org/project/python-can/#data

To Reproduce

Running the command from the documentation, pip install 'python-can[gs_usb]', prints the warning:

WARNING: python-can 4.5.0 does not provide the extra 'gs_usb'

Running pip install 'python-can[gs-usb]' is successful.

Expected behavior

The command from the documentation should be consistent with the extra name in the pypi registry, i.e. they should either both be gs-usb or both be gs_usb.

Additional context

OS and version: Debian GNU/Linux 12 (bookworm) Python version: 3.11.2 python-can version: 4.5.0 python-can interface/s (if applicable): gs_usb

trupples avatar Jan 31 '25 13:01 trupples