Windows-Bluetooth-Watcher

中文

Table of Contents

• Windows-Bluetooth-Watcher
  • Table of Contents
  • I. Introduction
  • II. Usage
    • 2.1 Pre-built Package
    • 2.2 Building from Source
      • 2.2.1 Prerequisites
      • 2.2.2 Clone
      • 2.2.3 Build
      • 2.2.4 Installation
  • III. Documentation
  • IV. Breaking Changes
  • V. License

I. Introduction

This project is a secondary development based on the windows crate. It primarily wraps related methods for obtaining the connection status of Bluetooth devices on the Windows system and uses PyO3 for Python bindings to provide it as a Python library.

II. Usage

2.1 Pre-built Package

You can use our pre-built version for windows-amd64 devices with the following command:

pip install windows-bluetooth-watcher

2.2 Building from Source

2.2.1 Prerequisites

• System: Windows 10 or later
• Environment: Rustup full toolchain, Python>=3.10, maturin>=1.9, git

2.2.2 Clone

Execute the following commands to clone the project locally:

git clone https://github.com/starwindv/Windows-Bluetooth-Watcher.git
cd Windows-Bluetooth-Watcher

2.2.3 Build

maturin build # or python -m build

Depending on the command used, the build artifacts are located in the following two locations:

Using maturin: .\target\wheels\windows_bluetooth_watcher-{proj_version}-{py_version}-{py_version}-win_{architecture}.whl

Using python: .\dist\windows_bluetooth_watcher-{proj_version}.tar.gz and .\dist\windows_bluetooth_watcher-{proj_version}-{py_version}-{py_version}-win_{architecture}.whl

2.2.4 Installation

python -m pip install {path_to_wheel}

III. Documentation

You can generate the documentation using cargo doc in the project's root directory, or check our curated detailed documentation

IV. Breaking Changes

You can find descriptions of possible breaking changes in each version in BREAKING.md.

V. License

This project is licensed under the GPL-3.0 license. However, please note that developers listed in the AUTHORS file are granted an exception to the GPL-3.0 license. This exception allows them to use this project in the development of each branch project under the corresponding project without being subject to its copyleft requirements.

All other users must still comply with the full terms of the GPL-3.0.