Skip to main content

pulse.eco API wrapper

Project description

pulse-eco

GitHub Workflow Test codecov GitHub Workflow Build

PyPI PyPI - Python Version

Ruff types - Mypy GitHub license

pulse.eco logo

pulse.eco client for Python.

Installation

Requires Python version 3.8+.

The pulse-eco package comes with no base dependencies, everything is an extra. A sensible default is:

python -m pip install pulse-eco[client,httpx]

List of extras

  • client - includes Pydantic, used for the higher level validated client (pulseeco.client).
  • requests - includes requests HTTP client with sync support.
  • aiohttp - includes aiohttp HTTP client with async support.
  • httpx - includes HTTPX HTTP client with both sync and async support.

Documentation

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

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

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 Python client performs 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

To delete the environment, run:

hatch env remove 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulse_eco-2.3.2.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

pulse_eco-2.3.2-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file pulse_eco-2.3.2.tar.gz.

File metadata

  • Download URL: pulse_eco-2.3.2.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for pulse_eco-2.3.2.tar.gz
Algorithm Hash digest
SHA256 2e0e7ec3e5070a55588aa5335b42636f834a003c172a446e759156e3206c0cfa
MD5 6b027eb7a3862e843793ab5a9c209d9b
BLAKE2b-256 3e0b34f76dac44a336751a778dc615a1cff150b305ac8be8bdf66c8efc61cb5d

See more details on using hashes here.

Provenance

File details

Details for the file pulse_eco-2.3.2-py3-none-any.whl.

File metadata

  • Download URL: pulse_eco-2.3.2-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for pulse_eco-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 308d53de437969e9fad603e9df0d64693dccda41fbff41e2371acab05657cf4d
MD5 23f266894cae184e36cb3cb58caaa251
BLAKE2b-256 9113407dc3d7b01d0352f45f2e67e6072bd60c2e5a67414df86b592f2185295b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page