Skip to main content

Python Wrapper for interacting with the Volkszahler API.

Project description

Python API for interacting with Volkszaehler. At the moment only the consumption of data is supported. Sorry, uploading is not possible.

This module is not official, developed, supported or endorsed by Volkzaehler.

Installation

The module is available from the Python Package Index.

$ pip3 install volkszaehler

On a Fedora-based system or a CentOS/RHEL host with EPEL.

$ sudo dnf -y install python3-volkszaehler

For Nix or NixOS users is a package available. Keep in mind that the lastest releases might only be present in the unstable channel.

$ nix-env -iA nixos.python39Packages.volkszaehler

Usage

The file example.py contains an example about how to use this module.

Basically it’s just a wrapper to get the JSON data from a given UUID which represents the device.

$ http https://demo.volkszaehler.org/middleware.php/data/57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json
[...]
{
    "data": {
        "average": 0.01,
        "consumption": 38.099,
        "from": 1584390593336,
        "max": [
            1597701600000,
            0.01
        ],
        "min": [
            1597701600000,
            0.01
        ],
        "rows": 3,
        "to": 1598106085887,
        "tuples": [
            [
                1597701600000,
                0.01,
                1
            ],
            [
                1598106085887,
                0.01,
                1
            ]
        ],
        "uuid": "57acbef0-88a9-11e4-934f-6b0f9ecd95a8"
    },
    "version": "0.3"
}

Development

For development is recommended to use a venv.

$ python3 -m venv .
$ source bin/activate
$ python3 setup.py develop

License

python-volkszaehler is licensed under MIT, for more details check LICENSE.

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

volkszaehler-0.2.2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

volkszaehler-0.2.2-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file volkszaehler-0.2.2.tar.gz.

File metadata

  • Download URL: volkszaehler-0.2.2.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.2

File hashes

Hashes for volkszaehler-0.2.2.tar.gz
Algorithm Hash digest
SHA256 d68ab3842dd8ab6577d05de296bf34bca1674e623f09d2152eeccc948af8d312
MD5 186766005b2583e8fb0ff1b6fe07db2d
BLAKE2b-256 c2e25f1c4878b0f3054abedb50ed15dc13efa766b18d5932640b43d35f4cfa82

See more details on using hashes here.

File details

Details for the file volkszaehler-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: volkszaehler-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.9.2

File hashes

Hashes for volkszaehler-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a2944ca958d84114f437ced7fe8fa3b66faae84945d02b276235e22cbce243e9
MD5 ab2cdc8342fd6006077f500743e28e3a
BLAKE2b-256 7d01a4f85690801d5c08da32fb2d421099bfa549e6b92cdea1d168ef1588bfb4

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