hidapi · Python Simple Repository Browser

Project Links

Meta

Author: Pavol Rusnak

Maintainer: Pavol Rusnak

Classifiers

Operating System

MacOS :: MacOS X
Microsoft :: Windows
POSIX

License

OSI Approved :: BSD License
OSI Approved :: GNU General Public License v3 (GPLv3)

Programming Language

Python :: 3.5
Python :: 3.6
Python :: 3.7
Python :: 3.8
Python :: 3.9

Description

A Cython interface to HIDAPI library.

This has been tested with:

TREZOR Hardware Wallet
the PIC18F4550 on the development board from CCS with their example program
the Fine Offset WH3081 Weather Station

It works on Linux, Windows and macOS.

Software Dependencies

Python
Cython
hidraw or libusb+libudev on Linux

License

cython-hidapi may be used by one of three licenses as outlined in LICENSE.txt

Install

$ sudo apt-get install python-dev libusb-1.0-0-dev libudev-dev
$ sudo pip install --upgrade setuptools
$ sudo pip install hidapi

For other download options visit the PyPi page.

Build from source

Download cython-hidapi archive:

$ git clone --recursive https://github.com/trezor/cython-hidapi.git
$ cd cython-hidapi

Build cython-hidapi extension module:
```
$ python setup.py build
```
On Linux, the hidraw API is now used by default, and the libusb API is not included. That is, –without-libusb is now the default behavior. To force the use of the libusb API instead, use the –with-libusb option:
```
$ python setup.py build --with-libusb
```
Or you can also use the environment variable:
```
$ export HIDAPI_WITH_LIBUSB=1
$ python setup.py build
```
Install cython-hidapi module into your Python distribution:
```
$ sudo python setup.py install
```
Alternatively, you can run pip directly, which will call the necessary build and install commands:
```
$ pip install -e .
```
Test install:
```
$ python
>>> import hid
>>>
```
Try example script:
```
$ python try.py
```

Udev rules

For correct functionality under Linux, you need to create a rule file similar to this one in your udev rules directory.

Also you might need to call udevadm control --reload-rules to reload the rules.

Documentation

Documentation can be built using Sphinx:

$ cd docs && make html

The HTML output will be in docs/_build/html.

The documentation is extracted from the code using autodoc.

Note that the build output is used. So rebuilt the package before generating documentation.

Built documentation is also deployed to: https://trezor.github.io/cython-hidapi/.

0.14.0.post4 Nov 19, 2024

0.14.0.post3 Nov 06, 2024

0.14.0.post2 Jul 23, 2024

0.14.0.post1 Jul 23, 2024

0.14.0 May 28, 2023

0.13.1 Jan 12, 2023

0.12.0.post2 Jun 06, 2022

0.12.0.post1 Jun 06, 2022

0.12.0 Jun 05, 2022

0.11.2 Mar 27, 2022

0.11.0.post2 Oct 18, 2021

0.11.0.post1 Oct 18, 2021

0.11.0 Oct 17, 2021

0.10.1 Nov 26, 2020

0.10.0.post1 Oct 29, 2020

0.10.0 Oct 28, 2020

0.9.0.post3 Jun 20, 2020

0.9.0.post2 Feb 07, 2020

0.9.0.post1 Feb 03, 2020

0.9.0 Feb 03, 2020

0.7.99.post21 Oct 10, 2017

0.7.99.post20 Oct 29, 2016

0.7.99.post19 Sep 20, 2016

0.7.99.post18 Sep 06, 2016

0.7.99.post17 May 18, 2016

0.7.99.post16 May 16, 2016

0.7.99.post15 May 10, 2016

0.7.99.post14 Mar 03, 2016

0.7.99.post13 Mar 01, 2016

0.7.99.post12 Jan 19, 2016

0.7.99.post11 Jan 14, 2016

0.7.99.post10 Jan 12, 2016

0.7.99.post9 Dec 16, 2015

0.7.99.post8 Sep 29, 2015

Wheel compatibility matrix

Platform	CPython 3.6	CPython 3.7	CPython 3.8	CPython 3.9	CPython 3.10	CPython 3.11	CPython 3.12	CPython 3.13
macosx_10_13_x86_64
macosx_10_9_x86_64
macosx_11_0_arm64
manylinux2014_aarch64
manylinux2014_i686
manylinux2014_x86_64
manylinux_2_17_aarch64
manylinux_2_17_i686
manylinux_2_17_x86_64
musllinux_1_2_aarch64
musllinux_1_2_i686
musllinux_1_2_x86_64
win32
win_amd64