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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pycaruna-1.0.3.tar.gz.

File metadata

  • Download URL: pycaruna-1.0.3.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pycaruna-1.0.3.tar.gz
Algorithm Hash digest
SHA256 84c390b0ee3387761020484db98b904907de9d434c2913144f29c602f65a2f15
MD5 8a34e0e5d85acfd36cb272805199b61e
BLAKE2b-256 f8895601acadf58bf141f2702416b029ad985529a17032528c1641cb03c29eff

See more details on using hashes here.

File details

Details for the file pycaruna-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: pycaruna-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pycaruna-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ef9515d651e85bf2ff72efe60e7ec3585e3bf2ae8747331a039c219e03f8e8c8
MD5 1c2867ab5580a8d35b5969c923b4422a
BLAKE2b-256 d9508e513b09655e5e039e4f11b332156cc7b4f58fa57ced854cc7b4ba969196

See more details on using hashes here.

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