Metadata-Version: 2.5
Name: usbbluetooth
Version: 0.3.0
Summary: Take full control of your USB Bluetooth controllers!
Project-URL: Homepage, https://usbbluetooth.github.io/
Project-URL: Bug Tracker, https://github.com/usbbluetooth/usbbluetooth-python/issues
Author-email: Antonio Vázquez Blanco <antoniovazquezblanco@gmail.com>
License: GPL-3.0-only
License-File: LICENSE.md
Keywords: bluetooth
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Requires-Python: >=3.10
Requires-Dist: pyserial>=3.0
Requires-Dist: pyusb<2,>=1.1.0
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Description-Content-Type: text/markdown

# USB Bluetooth

[![Build](https://github.com/usbbluetooth/usbbluetooth-python/actions/workflows/build.yml/badge.svg)](https://github.com/usbbluetooth/usbbluetooth-python/actions/workflows/build.yml)
[![CodeQL](https://github.com/usbbluetooth/usbbluetooth-python/actions/workflows/codeql.yml/badge.svg)](https://github.com/usbbluetooth/usbbluetooth-python/actions/workflows/codeql.yml)
[![PyPI](https://img.shields.io/pypi/v/usbbluetooth)](https://pypi.org/project/usbbluetooth/)
[![Python versions](https://img.shields.io/pypi/pyversions/usbbluetooth.svg)](https://pypi.org/project/usbbluetooth/)
[![Snyk package health](https://img.shields.io/badge/Snyk-package%20health-4C4A73?logo=snyk&logoColor=white)](https://snyk.io/advisor/python/usbbluetooth)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/usbbluetooth/usbbluetooth-python/badge)](https://scorecard.dev/viewer/?uri=github.com/usbbluetooth/usbbluetooth-python)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE.md)

Take full control of your USB Bluetooth controllers from Python!

If you want to use this library with Scapy, please check out [scapy-usbbluetooth](https://pypi.org/project/scapy-usbbluetooth/).

For general documentation about the project, please visit [usbbluetooth.github.io](https://usbbluetooth.github.io).

For a C version of this library, check out [UsbBluetooth for C](https://github.com/usbbluetooth/usbbluetooth).

For a C# version of this library, check out [UsbBluetooth for C#](https://github.com/usbbluetooth/usbbluetooth-csharp).

## Installation

Just use pip :)

```
pip install usbbluetooth
```

## Usage

Once installed, you may list devices using `usbbluetooth.list_controllers()`, and for each device you may `open()` the device, `write()` and `read()` to them and `close()` it once you are done.
See the [examples](examples/) folder for some sample code.

## Plaform quirks

This package has some requirements to work because of different platform particularities.
To make sure the package works, please, see <https://usbbluetooth.github.io/quirks/>

## History

Package versions `< 0.1` were bindings around the original C library.
The history for those packages can be found in the [usbbluetooth repository](https://github.com/usbbluetooth/usbbluetooth) in the respective tags.

Package versions `>= 0.1` are developed in this repo and based of `pyusb`, the Python LibUSB binding.
