Volue Insight API python library for working with timeseries.
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 having a valid Volue Insight account. Please contact sales.insight@volue.com in order to get a trial account.
The library is tested against Python 3.9, 3.10, 3.11 and 3.12 - we recommend using the latest Python version.
The documentation with various examples is hosted on Read the Docs.
You can simply install/update the latest version of Volue Insight API python library with pip. Start a terminal (a shell) and use the following command
pip install -U volue-insight-timeseriesWe strongly recommend to pin your dependency on our package, since we will do changes to the package as we introduce new features, fix issues etc. See example below. At least make sure you lock down the major version in your requirements.txt file in order to prevent your code to break when we do breaking changes.
# your requirements.txt
volue-insight-timeseries==1.0.0 # Good
volue-insight-timeseries # BadWe follow Semantic Versioning principles to communicate the type of change from one version to the next, together with release notes.
If you previously have used wapi-python, you should switch to use this package going forward. We will not add any new features to wapi-python, it is only in the event of a severe bug that we will do any changes to it.
These are the steps you will have to do in order to successfully make the switch.
- Use Python 3.9, 3.10, 3.11 or 3.12
- Use Pandas 1.5.0 or newer
- Use zoneinfo, not pytz for handling time zone information
Copyright (c) 2018-2022 Volue Insight 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.