Skip to main content

Caruna API Python implementation

Project description

pycaruna

PyPI version

Basic Python implementation for interfacing with Caruna Plus (sometimes called Caruna+). It supports only basic methods, but enough to extract electricity usage data for further processing.

Supported features:

  • Get user profile information
  • Get metering points ("assets")
  • Get consumption data (daily/hourly)

Usage

The project is published on PyPI: https://pypi.org/project/pycaruna/ . You can use this package by adding the following to your requirements.txt:

pycaruna

The examples/ directory has example Python programs illustrating how to use the library.

The resources/ directory has examples of API response structures.

Caveats

  • During daylight savings time changes, the API may return a duplicate datapoint (same timestamp in two consecutive data points). See https://github.com/Jalle19/pycaruna/issues/7 for more details.
  • The authentication procedure requires a lot of HTTP requests to be sent back and forth, so the process is relatively slow. It's best to store and reuse the token produced by it instead of doing the authentication process all over again all the time.

Related projects

  • caruna-influxdb - a collection of scripts for ingesting your Caruna data into InfluxDB

Credits

https://github.com/kimmolinna/pycaruna

License

MIT

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

pycaruna-1.0.3.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

pycaruna-1.0.3-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

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