python-volkszaehler
===================
Python API for interacting with `Volkszaehler <https://volkszaehler.org>`_. 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 <https://pypi.python.org/pypi>`_.
.. code:: bash
$ pip3 install volkszaehler
On a Fedora-based system or a CentOS/RHEL host with EPEL.
.. code:: bash
$ 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.
.. code:: bash
$ 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.
.. code:: bash
$ 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"
}
License
-------
``python-volkszaehler`` is licensed under MIT, for more details check LICENSE.
Raw data
{
"_id": null,
"home_page": "https://github.com/home-assistant-ecosystem/python-volkszaehler",
"name": "volkszaehler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Fabian Affolter",
"author_email": "fabian@affolter-engineering.ch",
"download_url": "https://files.pythonhosted.org/packages/0e/50/70b75ff8175aeec360e666ebd95b6649178875f7f832e1aecfb0c16aa014/volkszaehler-0.4.0.tar.gz",
"platform": null,
"description": "python-volkszaehler\n===================\n\nPython API for interacting with `Volkszaehler <https://volkszaehler.org>`_. At\nthe moment only the consumption of data is supported. Sorry, uploading is not\npossible.\n\nThis module is not official, developed, supported or endorsed by Volkzaehler.\n\nInstallation\n------------\n\nThe module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.\n\n.. code:: bash\n\n $ pip3 install volkszaehler\n\nOn a Fedora-based system or a CentOS/RHEL host with EPEL.\n\n.. code:: bash\n\n $ sudo dnf -y install python3-volkszaehler\n\nFor Nix or NixOS users is a package available. Keep in mind that the lastest releases might only\nbe present in the ``unstable`` channel.\n\n.. code:: bash\n\n $ nix-env -iA nixos.python39Packages.volkszaehler\n\nUsage\n-----\n\nThe file ``example.py`` contains an example about how to use this module.\n\nBasically it's just a wrapper to get the JSON data from a given UUID which\nrepresents the device.\n\n.. code:: bash\n\n $ http https://demo.volkszaehler.org/middleware.php/data/57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json\n [...]\n {\n \"data\": {\n \"average\": 0.01,\n \"consumption\": 38.099,\n \"from\": 1584390593336,\n \"max\": [\n 1597701600000,\n 0.01\n ],\n \"min\": [\n 1597701600000,\n 0.01\n ],\n \"rows\": 3,\n \"to\": 1598106085887,\n \"tuples\": [\n [\n 1597701600000,\n 0.01,\n 1\n ],\n [\n 1598106085887,\n 0.01,\n 1\n ]\n ],\n \"uuid\": \"57acbef0-88a9-11e4-934f-6b0f9ecd95a8\"\n },\n \"version\": \"0.3\"\n }\n\nLicense\n-------\n\n``python-volkszaehler`` is licensed under MIT, for more details check LICENSE.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Wrapper for interacting with the Volkszahler API.",
"version": "0.4.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "79eac42cbbc26abfdefc82a908beb63f",
"sha256": "07f3ad58f2a525fa158e36970d1d1977545815c23f1543a4a9f67395a8f9f112"
},
"downloads": -1,
"filename": "volkszaehler-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "79eac42cbbc26abfdefc82a908beb63f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5309,
"upload_time": "2022-12-24T11:04:27",
"upload_time_iso_8601": "2022-12-24T11:04:27.124469Z",
"url": "https://files.pythonhosted.org/packages/0e/50/70b75ff8175aeec360e666ebd95b6649178875f7f832e1aecfb0c16aa014/volkszaehler-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-24 11:04:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "home-assistant-ecosystem",
"github_project": "python-volkszaehler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "volkszaehler"
}
JSON
