usbx


Nameusbx JSON
Version 0.8.0 PyPI version JSON
download
home_pageNone
SummaryModern and user-friendly library for working with USB devices
upload_time2024-09-21 13:00:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2024 Manuel Bleichenbacher Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords usb usb-host usb-devices
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">

![usbx](https://github.com/manuelbl/usbx/raw/main/docs/_static/usbx-github.svg)

</h1>


**usbx** is a modern, powerful and user-friendly Python library for working with USB devices.
It provides many useful features:

- Querying information about connected devices
- Communication with USB devices
- Notification when devices are connected and disconnected
- Single API for Windows, Linux and macOS
- Good documentation
- Thread-safe
- No need to install further software like *libusb*

**usbx** is easy to use:

```pycon
>>> from usbx import usb
>>> for device in usb.get_devices():
...     print(device)
...
USD device 4295171929, vid=0x1a40, pid=0x0801, manufacturer=None, product=USB 2.0 Hub, serial=None
USD device 4295171974, vid=0x0b0e, pid=0x0412, manufacturer=None, product=Jabra SPEAK 410 USB, serial=783F92B9DD3Cx011200
```


## Installing

**usbx** can be installed with [pip](https://pip.pypa.io):

```shell
python -m pip install usbx
```



## Usage

The [User Guide](https://usbx.readthedocs.io/en/stable/user-guide.html) will get you started with the library.
Also read [Platform-specific Considerations](https://usbx.readthedocs.io/en/stable/platform-specific.html)
as some operating systems might need extra steps to work with USB devices.



The [API Reference](https://usbx.readthedocs.io/en/stable/reference/index.html) documentation provides API-level documentation.


## License

**usbx** is made available under the MIT License. For more details, see [The MIT License](https://opensource.org/licenses/MIT>).


## Contributing

This is an open-source project that happily accepts contributions.
Please see [Contributing](https://usbx.readthedocs.io/en/stable/contributing.html) for details.


## System Requirements

- Python 3.9 or higher
- 64-bit application
- Windows (x86-64 or ARM), Linux (x86-64 or ARM), macOS (x86-64 or ARM)
- For Linux: *udev* (usually goes together with *systemd*)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "usbx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "usb, usb-host, usb-devices",
    "author": null,
    "author_email": "\"Manuel Bl.\" <manuel.bleichenbacher@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ff/3e/4692198bbca08fb76d6668f91782546fd2baddfae02959f8c53a05191aeb/usbx-0.8.0.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\n\n![usbx](https://github.com/manuelbl/usbx/raw/main/docs/_static/usbx-github.svg)\n\n</h1>\n\n\n**usbx** is a modern, powerful and user-friendly Python library for working with USB devices.\nIt provides many useful features:\n\n- Querying information about connected devices\n- Communication with USB devices\n- Notification when devices are connected and disconnected\n- Single API for Windows, Linux and macOS\n- Good documentation\n- Thread-safe\n- No need to install further software like *libusb*\n\n**usbx** is easy to use:\n\n```pycon\n>>> from usbx import usb\n>>> for device in usb.get_devices():\n...     print(device)\n...\nUSD device 4295171929, vid=0x1a40, pid=0x0801, manufacturer=None, product=USB 2.0 Hub, serial=None\nUSD device 4295171974, vid=0x0b0e, pid=0x0412, manufacturer=None, product=Jabra SPEAK 410 USB, serial=783F92B9DD3Cx011200\n```\n\n\n## Installing\n\n**usbx** can be installed with [pip](https://pip.pypa.io):\n\n```shell\npython -m pip install usbx\n```\n\n\n\n## Usage\n\nThe [User Guide](https://usbx.readthedocs.io/en/stable/user-guide.html) will get you started with the library.\nAlso read [Platform-specific Considerations](https://usbx.readthedocs.io/en/stable/platform-specific.html)\nas some operating systems might need extra steps to work with USB devices.\n\n\n\nThe [API Reference](https://usbx.readthedocs.io/en/stable/reference/index.html) documentation provides API-level documentation.\n\n\n## License\n\n**usbx** is made available under the MIT License. For more details, see [The MIT License](https://opensource.org/licenses/MIT>).\n\n\n## Contributing\n\nThis is an open-source project that happily accepts contributions.\nPlease see [Contributing](https://usbx.readthedocs.io/en/stable/contributing.html) for details.\n\n\n## System Requirements\n\n- Python 3.9 or higher\n- 64-bit application\n- Windows (x86-64 or ARM), Linux (x86-64 or ARM), macOS (x86-64 or ARM)\n- For Linux: *udev* (usually goes together with *systemd*)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Manuel Bleichenbacher  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Modern and user-friendly library for working with USB devices",
    "version": "0.8.0",
    "project_urls": {
        "Homepage": "https://github.com/manuelbl/usbx",
        "Issues": "https://github.com/manuelbl/usbx/issues"
    },
    "split_keywords": [
        "usb",
        " usb-host",
        " usb-devices"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81eceb891374459dbe3d6e027882334cc2aa862562023fc62cf4937dee339efb",
                "md5": "c28fdbee74adfe5329f5e3dab0c3ec62",
                "sha256": "67d258eb4aaf556b76b4442fbd957c7d613955e58c11977187d9e30c38b0f1e5"
            },
            "downloads": -1,
            "filename": "usbx-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c28fdbee74adfe5329f5e3dab0c3ec62",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 57231,
            "upload_time": "2024-09-21T13:00:02",
            "upload_time_iso_8601": "2024-09-21T13:00:02.337892Z",
            "url": "https://files.pythonhosted.org/packages/81/ec/eb891374459dbe3d6e027882334cc2aa862562023fc62cf4937dee339efb/usbx-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff3e4692198bbca08fb76d6668f91782546fd2baddfae02959f8c53a05191aeb",
                "md5": "ce55c7e29df1bbd0fe5bc87b191b4add",
                "sha256": "77991367afc4db8eb987a787e9947896f755779091dd67c9d3d83cd7878080bf"
            },
            "downloads": -1,
            "filename": "usbx-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ce55c7e29df1bbd0fe5bc87b191b4add",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 48421,
            "upload_time": "2024-09-21T13:00:04",
            "upload_time_iso_8601": "2024-09-21T13:00:04.571091Z",
            "url": "https://files.pythonhosted.org/packages/ff/3e/4692198bbca08fb76d6668f91782546fd2baddfae02959f8c53a05191aeb/usbx-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-21 13:00:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "manuelbl",
    "github_project": "usbx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "usbx"
}
        
Elapsed time: 0.29112s