Skip to content

Inconsistency between gs_usb in install instructions and pip #1917

Open
@trupples

Description

@trupples

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).

Install: ``pip install "python-can[gs_usb]"``

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions