https://github.com/o-murphy/bleak-pythonista
Bleak-compatible backend for Pythonista iOS app
https://github.com/o-murphy/bleak-pythonista
ble bleak ios python pythonista
Last synced: 4 months ago
JSON representation
Bleak-compatible backend for Pythonista iOS app
- Host: GitHub
- URL: https://github.com/o-murphy/bleak-pythonista
- Owner: o-murphy
- License: mit
- Created: 2025-07-25T20:10:59.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-09-01T10:05:28.000Z (4 months ago)
- Last Synced: 2025-09-01T12:34:56.837Z (4 months ago)
- Topics: ble, bleak, ios, python, pythonista
- Language: Python
- Homepage: https://pypi.org/project/bleak-pythonista
- Size: 85.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# `Bleak` compatible backend for `Pythonista` iOS app
[![license]][MIT]
[![pypi]][PyPiUrl]
[![py-versions]][sources]
[![Made in Ukraine]][SWUBadge]
[](https://github.com/o-murphy/bleak-pythonista/actions/workflows/pytest.yml)
[](https://github.com/o-murphy/bleak-pythonista/actions/workflows/mypy.yml)
[](https://github.com/o-murphy/bleak-pythonista/actions/workflows/ruff.yml)
[sources]:
https://github.com/o-murphy/bleak-pythonista
[license]:
https://img.shields.io/github/license/o-murphy/bleak-pythonista?style=flat-square
[MIT]:
https://opensource.org/license/MIT
[pypi]:
https://img.shields.io/pypi/v/bleak-pythonista?style=flat-square&logo=pypi
[PyPiUrl]:
https://pypi.org/project/bleak-pythonista/
[pepy]:
https://pepy.tech/project/bleak-pythonista
[py-versions]:
https://img.shields.io/pypi/pyversions/bleak-pythonista?style=flat-square
[Made in Ukraine]:
https://img.shields.io/badge/made_in-Ukraine-ffd700.svg?labelColor=0057b7&style=flat-square
[SWUBadge]:
https://stand-with-ukraine.pp.ua
**This module uses `bleak` backend API to implement a compatible solution for `Pythonista` iOS app.
It uses Pythonista built-in `_cb` module, that is wrapper to iOS `CoreBluetooth`.**
> [!CAUTION]
> This project is in `beta`, use it with caution
* This backend refers to [Pythonista.cb docs](https://omz-software.com/pythonista/docs/ios/cb.html)
* This backend refers to existing [`macOS CoreBluetooth bleak backend`](https://github.com/hbldh/bleak/tree/develop/bleak/backends/corebluetooth) was used as a reference
* It also provides stub files for pythonista built-in modules as `_cb` and `pythonista.cb`, and fake `_cb.py` implementation for testing on unsupported platforms
* Use [`Bleak` docs](https://github.com/hbldh/bleak/blob/develop/README.rst) to explore how to use `Bleak`
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [What's done?](#whats-done)
* [Contributing](CONTRIBUTING.md)
## Installation
```Bash
pip install bleak-pythonista
```
## Usage
Direct import
```python
import asyncio
from bleak_pythonista import BleakScanner, BleakClient
async def main():
devices = await BleakScanner.discover(
service_uuids=[""] # optional
)
for d in devices:
print(d)
client = BleakClient(d)
await client.connect()
print(client.services)
asyncio.run(main())
```
With `bleak` itself
```python
import asyncio
from bleak import BleakScanner, BleakClient
from bleak_pythonista import BleakScannerPythonistaCB, BleakClientPythonistaCB
async def main():
devices = await BleakScanner.discover(
service_uuids=[""], # optional
backend=BleakScannerPythonistaCB,
)
for d in devices:
print(d)
client = BleakClient(d, backend=BleakClientPythonistaCB)
await client.connect()
print(client.services)
asyncio.run(main())
```
> [!WARNING]
> DO NOT NAME YOUR SCRIPT `bleak.py` or `bleak_pythonista`! It will cause a circular import error.
## What's done?
* CentralManagerDelegate (for now for scanning purpose only)
* client.BleakClientPythonistaCB
* scanner.BleakScannerPythonistaCB
* `_cb` and `pythonista.cb` stubs
* fake `cb.py` for testing with backend simulation on unsupported platforms
> [!TIP]
> 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.