Install the SDK

From PyPI

pip install tap-python-sdk

From source

git clone https://github.com/TapWithUs/tap-python-sdk
cd tap-python-sdk
pip install .

For development (tests and flake8):

pip install .[dev]

Platform prerequisites

macOS

Uses Apple CoreBluetooth via Bleak. If you use a non-system Python, install PyObjC for that interpreter. The SDK pins bleak==0.12.1 on Darwin.

Windows 10+

Uses Bleak with WinRT (bleak==0.22.3 and bleak-winrt==1.2.0). No external DLL is required.

Linux

Install BlueZ tools and grant Bluetooth access:

sudo apt-get install bluez-tools libbluetooth-dev
sudo usermod -G bluetooth -a <username>
su - $USER

The device’s Bluetooth name must start with Tap for the Linux discovery path.

Verify the import

python -c "from tapsdk import TapSDK; print('ok')"