Metadata-Version: 2.4
Name: pulsoid-client
Version: 0.0.2
Summary: A library that lets you retrieve heart rate data from Pulsoid without using an API key
Author-email: ctih1 <ctih1@frii.site>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ctih1/pulsoid-client
Project-URL: Issues, https://github.com/ctih1/pulsoid-client/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# PulsoidClient
A simple Python package meant for accessing heart rate data from Pulsoid without the use of an API key.

## Installation
Just run `pip install git+https://github.com/ctih1/pulsoid-client`

## Setup
In order to use this method, you have to use Pulsoid Cloud (connect your preferred heart rate device to your phone, and use the mobile app). 

### 1. Make sure your pulse is visible in the Pulsoid app
![Pulsoid app showing heart rate](examples/setup/app.png)

### 2. Go to https://pulsoid.net/ui/configuration

### 3. Select any one of the trackers available, and click "configure"
![Pulsoid website with lots of widgets showing cursor on top of the "configure" button](examples/setup/widgets.png)

### 4. Click "Copy" next to the source URL
![Pulsoid widget configuration site with the mouse hovering over "Copy" button, which copies the URL starting with https://pulsoid.net/widget/view/...](examples/setup/id_visible.png)

### 5. Use it with the Python library
```python
from pulsoid_client import PulsoidClient

client = PulsoidClient(widget_url="https://pulsoid.net/widget/view/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", callback_function=heart_rate_callback)
```

### 6. See [`examples/`](https://github.com/ctih1/pulsoid-client/tree/master/examples) for more in-depth exampless



(NOTE: the "67" values were not intended, my heart rate just so happened to be that when I took the screenshots..)
