Skip to main content

Async Python 3 library for interacting with Discovergy smart meters API

Project description

pydiscovergy

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage

Asynchronous Python client for inexogy (former Discovergy) smart meter using their API.

About

This package allows you to fetch data from api.inexogy.com.

Installation

pip install pydiscovergy

Usage

import asyncio

from pydiscovergy import Discovergy

async def main():
    discovergy = Discovergy(email="demo@example.com", password="demo")
    meters = await discovergy.meters()

    for meter in meters:
        if meter.meter_id == "abc123":
            reading = await discovergy.meter_last_reading(meter_id=meter.meter_id)
            print(f"Last reading: {reading.values['energy']} kWh")

if __name__ == "__main__":
    asyncio.run(main())

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. I am always open to people who want to use the code or contribute to it.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • Poetry
  • NodeJS 20+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The content is by Jan-Philipp Benecke.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2023-2025 Jan-Philipp Benecke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

pydiscovergy-3.1.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

pydiscovergy-3.1.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file pydiscovergy-3.1.0.tar.gz.

File metadata

  • Download URL: pydiscovergy-3.1.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pydiscovergy-3.1.0.tar.gz
Algorithm Hash digest
SHA256 28c3478d50c9926f1016db0366f33a27c6c701d51951f9dadba47178b798103c
MD5 4c187ddb7b26424c091bef12af94b364
BLAKE2b-256 e963fe09d04735ac234b3ceebe00167e8bb709bfa73ca5f82c16d95054897ed2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydiscovergy-3.1.0.tar.gz:

Publisher: release.yml on jpbede/pydiscovergy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydiscovergy-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: pydiscovergy-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pydiscovergy-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7496943863bfaefd44feedb7ad31d618566996a8901e8407c0c17a500cd0993b
MD5 2a764a472b8ded56d68182578aa3da94
BLAKE2b-256 047ebef242c2a889b09f111d242eeec4a2de0cdbbfc82dc29d494571419ca154

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydiscovergy-3.1.0-py3-none-any.whl:

Publisher: release.yml on jpbede/pydiscovergy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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