pulse-eco 2.0.0

pulse.eco API wrapper

pulse-eco

pulse.eco client for Python.

Installation

pulse-eco is avialiable on PyPI:

python -m pip install pulse-eco

Requires Python version 3.8+.

Documentation

Official pulse.eco REST API documentation can be found on pulse.eco/restapi.

API Reference and User Guide for this package is available on GitHub Pages.

Requesting data with a larger time range

The pulse.eco API limits the maximum time span of data you can get from one request. For /dataRaw it is one week, while for /avgData it is one year.

If the time range is larger than the maximum, the pulse.eco client creates multiple requests to the API and then joins the data together. Be aware of this.

Development

Install Hatch

https://hatch.pypa.io/latest/install/

Create dev environment

Activate a Python 3.8 environment and run:

hatch env create dev

Install pre-commit hooks

hatch run dev:setup

Create .env file

Set auth credentials in .env file:

cp .env.example .env

Before committing

This command must pass without errors before committing:

hatch run dev:check

Docs

To preview the docs locally, run:

hatch run dev:docs-serve