pyusb

Easy USB access for Python

https://github.com/pyusb/pyusb

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    2 of 76 committers (2.6%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary

Keywords

hardware python usb

Keywords from Contributors

qt tensors kivy optimizing-compiler pillow pil test-data-generator test-data faker-generator faker
Last synced: 6 months ago · JSON representation

Repository

Easy USB access for Python

Basic Info
  • Host: GitHub
  • Owner: pyusb
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 1.26 MB
Statistics
  • Stars: 2,255
  • Watchers: 91
  • Forks: 668
  • Open Issues: 31
  • Releases: 6
Topics
hardware python usb
Created over 14 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.rst

==================================
PyUSB – Easy USB access for Python
==================================

Introduction
------------

PyUSB provides for easy access to the host machine's Universal Serial Bus (USB)
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
neutral Python USB module easy to use.

Documentation
-------------

The best way to get started with PyUSB is to read the following documents:

* `Tutorial`_
* `FAQ`_


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 [1]_::

    $ python -m pydoc usb

The `libusb 1.0 documentation`_ is also a recommended read, especially when
using that backend (more on this below).

Requirements and platform support
---------------------------------

PyUSB is primarily developed and tested on Linux and Windows, but it should
also work fine on any platform running Python >= 3.9, ctypes and at least one
of the built-in backends.

PyUSB supports `libusb 1.0`_, libusb 0.1 and OpenUSB. Of those, libusb 1.0 is
currently recommended for most use cases.

*On Linux and BSD,* these will generally be available on the distribution's
official repositories.

*On macOS,* libusb 1.0 can easily be installed through Homebrew::

    $ brew install libusb

*On Windows,* `pyocd/libusb-package`_ is a convenient [2]_ [3]_ way to
provide the necessary libusb 1.0 DLL, as well as a suitable PyUSB backend and
a easy to use wrapper over PyUSB's ``find()`` API::

    # with pure PyUSB
    for dev in usb.core.find(find_all=True):
        print(dev)

    # with pyocd/libusb-package
    for dev in libusb_package.find(find_all=True):
        print(dev)


Alternatively, the libusb 1.0 DLL can be manually copied from an official
release archive into the ``C:\Windows\System32`` system folder, or packaged
together with the complete application.

Installing
----------

PyUSB is generally installed through pip [1]_::

    # the latest official release
    python -m pip install pyusb

    # a specific version (replace  with the desired version)
    python -m pip install pyusb==

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

Most Linux distributions also package PyUSB in their official repositories.

Getting help
------------

If you have a question about PyUSB:

* consult the `FAQ`_;
* post a question in the `Q&A section`_;
* write to the `PyUSB mailing list`_.

To report a bug or propose a new feature, use our `issue tracker`_.  But please
search the database before opening a new issue.

Footnotes
---------

.. [1] On systems that still default to Python 2, replace ``python`` with
   ``python3``.

.. [2] Unlike PyUSB, pyocd/libusb-package uses the more restrictive Apache 2.0
   license.

.. [3] While pyocd/libusb-package supports platforms other than Windows,
   there are advantages to sticking to a system-provided libusb, if it is
   available and the platform has a robust package manager (e.g. Linux, BSD,
   macOS with Homebrew).

.. _FAQ: https://github.com/pyusb/pyusb/blob/master/docs/faq.rst
.. _PyUSB mailing list: https://sourceforge.net/projects/pyusb/lists/pyusb-users
.. _Q&A section: https://github.com/pyusb/pyusb/discussions/categories/q-a
.. _Tutorial: https://github.com/pyusb/pyusb/blob/master/docs/tutorial.rst
.. _issue tracker: https://github.com/pyusb/pyusb/issues
.. _libusb 1.0 documentation: https://libusb.info/
.. _libusb 1.0: https://github.com/libusb/libusb
.. _pyocd/libusb-package: https://github.com/pyocd/libusb-package/

Owner

  • Name: PyUSB
  • Login: pyusb
  • Kind: organization

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 486
  • Total Committers: 76
  • Avg Commits per committer: 6.395
  • Development Distribution Score (DDS): 0.521
Past Year
  • Commits: 14
  • Committers: 3
  • Avg Commits per committer: 4.667
  • Development Distribution Score (DDS): 0.214
Top Committers
Name Email Commits
Wander Lairson Costa w****n@g****m 233
Jonas Malaco j****s@p****o 108
wander.costa w****a@i****m 16
ap-- a****s@p****o 10
Tormod Volden d****d@g****m 7
Alan Aguiar a****s@h****m 6
Robert Wlodarczyk r****t@s****m 5
Chapman Flack c****p@a****t 5
Wander Lairson Costa w****a@m****m 5
Andrey Skvortsov a****v@g****m 4
wander.costa w****a@o****m 3
Simon Norberg s****n@d****t 3
clach04 C****k@a****m 3
André Erdmann d****i@m****e 3
David Halter d****8@g****m 2
Jacoby Johnson j****n@g****m 2
James Rowe j****e@g****m 2
Matt m****t@m****t 2
Prathmesh Prabhu p****u@c****g 2
Russell Proud r****d@g****m 2
endolith e****h@g****m 2
Peter A. Bigot b****p@a****g 2
jaseg j****g@j****t 2
Elliott Mitchell e****t@d****m 2
Walker Inman w****n@m****u 2
ponty p****y@h****e 2
clach04 c****4@t****) 2
Richard Bryan r****n@l****m 1
Nick Bogdanov n****v@g****m 1
Maximilian Köhl l****i@g****m 1
and 46 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 125
  • Total pull requests: 25
  • Average time to close issues: 3 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 106
  • Total pull request authors: 19
  • Average comments per issue: 5.95
  • Average comments per pull request: 3.84
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 9
  • Average time to close issues: 3 days
  • Average time to close pull requests: 11 days
  • Issue authors: 6
  • Pull request authors: 4
  • Average comments per issue: 1.5
  • Average comments per pull request: 2.44
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mcuee (7)
  • o-murphy (3)
  • ap-- (2)
  • danielhrisca (2)
  • jonasmalacofilho (2)
  • walac (2)
  • ibipark (2)
  • JartX (2)
  • jerome-diver (2)
  • torfbolt (2)
  • artisticfox8 (2)
  • erikaemma (2)
  • emob-nordic (2)
  • SergeTauger (1)
  • cybergibbons (1)
Pull Request Authors
  • jonasmalacofilho (6)
  • kauwua (3)
  • mikhail-ekzi (2)
  • AlanJAS (2)
  • russellproud (2)
  • twam (2)
  • o-murphy (2)
  • hroncok (1)
  • puddly (1)
  • andygoulden (1)
  • roberthartung (1)
  • nickrbogdanov (1)
  • Querela (1)
  • mrnuke (1)
  • Domefemia (1)
Top Labels
Issue Labels
question (58) enhancement (15) windows (10) libusb1 (10) doc (9) linux (7) invalid (6) duplicate (4) macOS (4) isoc_transfer (4) python3 (3) build (3) libusb0 (2) core (2) android (2) CI (1) Test (1) Release (1)
Pull Request Labels
enhancement (8) libusb1 (5) core (4) build (1) android (1) misc (1) doc (1) macOS (1) Test (1) linux (1)

Packages

  • Total packages: 22
  • Total downloads:
    • pypi 2,138,575 last-month
  • Total docker downloads: 819,135,766
  • Total dependent packages: 180
    (may contain duplicates)
  • Total dependent repositories: 3,697
    (may contain duplicates)
  • Total versions: 54
  • Total maintainers: 6
pypi.org: pyusb

Easy USB access for Python

  • Versions: 17
  • Dependent Packages: 136
  • Dependent Repositories: 3,692
  • Downloads: 2,138,575 Last month
  • Docker Downloads: 819,135,766
Rankings
Docker downloads count: 0.1%
Dependent packages count: 0.2%
Dependent repos count: 0.2%
Downloads: 0.3%
Average: 0.7%
Stargazers count: 1.6%
Forks count: 1.8%
Maintainers (3)
Last synced: 6 months ago
alpine-v3.18: py3-usb-pyc

Precompiled Python bytecode for py3-usb

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 2.1%
Forks count: 2.7%
Stargazers count: 5.6%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.18: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 2.1%
Forks count: 2.7%
Stargazers count: 5.6%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.14: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 6
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 2.2%
Average: 2.3%
Dependent packages count: 3.0%
Stargazers count: 3.9%
Maintainers (1)
Last synced: 6 months ago
alpine-edge: py3-usb

easy USB devices communication in Python3

  • Versions: 4
  • Dependent Packages: 9
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.8%
Average: 2.6%
Forks count: 3.7%
Stargazers count: 5.8%
Last synced: 6 months ago
alpine-v3.12: py3-usb

PyUSB offers easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 5
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 2.1%
Average: 2.6%
Stargazers count: 3.4%
Dependent packages count: 5.0%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.17: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 8
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 2.4%
Average: 3.2%
Dependent packages count: 4.5%
Stargazers count: 5.8%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.16: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 5
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 2.2%
Average: 3.5%
Stargazers count: 4.4%
Dependent packages count: 7.3%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.15: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 2.2%
Stargazers count: 4.1%
Average: 5.7%
Dependent packages count: 16.5%
Maintainers (1)
Last synced: 6 months ago
alpine-edge: py3-usb-pyc

Precompiled Python bytecode for py3-usb

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 3.8%
Average: 6.0%
Stargazers count: 6.1%
Dependent packages count: 14.1%
Last synced: 6 months ago
alpine-v3.13: py3-usb

PyUSB offers easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 2.2%
Stargazers count: 3.8%
Average: 6.4%
Dependent packages count: 19.5%
Maintainers (1)
Last synced: 6 months ago
proxy.golang.org: github.com/pyusb/pyusb
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago
conda-forge.org: pyusb

PyUSB offers easy USB devices communication in Python. It should work without additional code in any environment with Python >= 2.4, ctypes and an pre-built usb backend library (currently, libusb 0.1.x, libusb 1.x, and OpenUSB).

  • Versions: 5
  • Dependent Packages: 10
  • Dependent Repositories: 5
Rankings
Dependent packages count: 5.9%
Forks count: 6.3%
Average: 9.0%
Stargazers count: 9.2%
Dependent repos count: 14.7%
Last synced: 6 months ago
spack.io: py-pyusb

Easy USB access from Python.

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Forks count: 3.4%
Stargazers count: 5.5%
Average: 16.5%
Dependent packages count: 57.3%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.20: py3-usb-pyc

Precompiled Python bytecode for py3-usb

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.21: py3-usb-pyc

Precompiled Python bytecode for py3-usb

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 6 months ago
alpine-v3.21: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 6 months ago
alpine-v3.19: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.19: py3-usb-pyc

Precompiled Python bytecode for py3-usb

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 6 months ago
alpine-v3.20: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Maintainers (1)
Last synced: 6 months ago
alpine-v3.22: py3-usb-pyc

Precompiled Python bytecode for py3-usb

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 6 months ago
alpine-v3.22: py3-usb

easy USB devices communication in Python3

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 0.0%
Average: 100%
Last synced: 6 months ago

Dependencies

.github/workflows/run_tox.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v2 composite