Skip to content

Commit

Permalink
docs: readme: invoke pydoc and pip with python3 -m
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasmalacofilho committed Apr 8, 2022
1 parent 673cd76 commit 5d66133
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Introduction
------------

PyUSB provides for easy access to the host machine's Universal Serial Bus (USB)
system for Python.
system for Python 3.

Until 0.4 version, PyUSB used to be a thin wrapper over libusb. Starting with
the 1.0 version, things changed considerably: now PyUSB is an API rich, backend
Expand All @@ -25,7 +25,7 @@ For more detailed information, PyUSB's API documentation, as with most Python
modules, is based on Python doc strings and can be manipulated by tools such as
pydoc::

$ pydoc usb
$ python3 -m pydoc usb

The `libusb 1.0 documentation`_ is also a recommended read, especially when
using that backend (more on this bellow).
Expand Down Expand Up @@ -70,13 +70,13 @@ Installing
PyUSB is generally installed through pip::

# the latest official release
pip install pyusb
python3 -m pip install pyusb

# install a specific version (e.g. 1.2.1)
pip install pyusb==1.2.1
python3 -m pip install pyusb==1.2.1

# the latest snapshop from the official git repository
pip install pyusb git+https://github.com/pyusb/pyusb#egg=pyusb
python3 -m pip install pyusb git+https://github.com/pyusb/pyusb#egg=pyusb

Most Linux distributions also package PyUSB in their official repositories.

Expand Down

0 comments on commit 5d66133

Please sign in to comment.