/wapi-python

Python library for the Wattsight API

Primary LanguageJupyter NotebookMIT LicenseMIT

wapi-python

Wattsight API python library

This repo has been archived and will not receive any new updates, bugfixes, security updates or similar. Instead, please use https://github.com/volueinsight/volue-insight-timeseries which is our recommended python package for interacting with our timeseries API.

We informed about our new python package in a post to our customers on October 7th 2024 (https://volueinsight.com/en/blog/volue-insight-api-switch-to-the-new-volue-insight-timeseries-package/ - requires login). We have explained both in the blog post and in the new repo, why you should switch to the new package.

Wapi-python packages on PyPi will stay there - so you can continue installing it with pip, we do not plan to remove those versions. However, we cannot guarantee that it will be compatible with the API forever. If we do breaking changes in the API, we will give advice on how to transition in the new repo only, not here.

This library is meant as a simple toolkit for working with data from https://api.volueinsight.com/ (or equivalent services). Note that access is based on some sort of login credentials, this library is not all that useful unless you have a valid Wattsight account.

The library is tested against Python versions >=3.6 and <=3.9

Documentation

The documentation with various examples is hosted on Read the Docs.

Installation

You can simply install/update the latest version of Wattsight API python library with pip. Start a terminal (a shell) and use the following command

pip install -U wapi-python

Copyright (MIT License)

Copyright (c) 2018-2019 Wattsight AS

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.