Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: More renames for wapi #46

Merged
merged 5 commits into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Listening for changes
=====================


WAPI supports listening for changes to curves. An event listener is set up, and behaves
Volue Insight time series API supports listening for changes to curves. An event listener is set up, and behaves
like an infinite iterator, returning change events as they happen.

To create an event listener, find a list of curves (or a list of curve ids) and use that
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Quickstart
2. Import wapi and create a :class:`~volue_insight_timeseries.session.Session` to connect to the database using
your `authentication credentials`_ ::

import wapi
import volue_insight_timeseries
session = volue_insight_timeseries.Session(client_id='client id', client_secret='client secret')

3. Get a curve object by its name and fetch data from the curve. There are
Expand Down Expand Up @@ -62,6 +62,6 @@ Quickstart
'TIME_SERIES'


.. _authentication credentials: https://https://auth.volueinsight.com/account/oauth-clients
.. _authentication credentials: https://auth.volueinsight.com/account/oauth-clients
.. _pandas.Series: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.Series.html
.. _pandas.DataFrame: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.html
Original file line number Diff line number Diff line change
Expand Up @@ -8799,4 +8799,4 @@
},
"nbformat": 4,
"nbformat_minor": 2
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# Create a session to connect to Volue Insight API.
session = volue_insight_timeseries.Session(config_file=my_config_file)
# or
#session = wapi.Session(client_id='client id', client_secret='client secret')
#session = volue_insight_timeseries.Session(client_id='client id', client_secret='client secret')
############################################

# Define curve name to read, in this case the intraday price forecast.
Expand Down
10 changes: 6 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
requests >= 2.18
sseclient-py >= 1.7
pandas >= 1.5.0
future >= 0.16
requests>=2.18
sseclient-py>=1.7
pandas>=1.5.0
future>=0.16
matplotlib==3.8.2
plotly==5.18.0
2 changes: 1 addition & 1 deletion unittest/test_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ def test_minimal_config_file():
config_file = os.path.join(os.path.dirname(__file__), 'testconfig_minimal.ini')
s = vit.Session(config_file=config_file)
#
assert s.urlbase == 'https://api.wattsight.com'
assert s.urlbase == 'https://api.volueinsight.com'
assert s.auth is None


Expand Down
6 changes: 3 additions & 3 deletions volue_insight_timeseries/session.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
RETRY_COUNT = 4 # Number of times to retry
RETRY_DELAY = 0.5 # Delay between retried calls, in seconds.
TIMEOUT = 300 # Default timeout for web calls, in seconds.
API_URLBASE = 'https://api.wattsight.com'
AUTH_URLBASE = 'https://auth.wattsight.com'
API_URLBASE = 'https://api.volueinsight.com'
AUTH_URLBASE = 'https://auth.volueinsight.com'


class ConfigException(Exception):
Expand All @@ -37,7 +37,7 @@ class Session(object):
suthentication information either directly by using a ```client_id` and
``client_secret`` or using a ``config_file`` .

See https://api.wattsight.com/#documentation for information how to get
See https://api.volueinsight.com/#documentation for information how to get
your authentication data.

Parameters
Expand Down
Loading