automatic import of python-eris-api

3 files changed, 786 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..13fb81e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/ERIS-API-1.5.1.tar.gz
diff --git a/python-eris-api.spec b/python-eris-api.spec
new file mode 100644
index 0000000..25a37c4
--- /dev/null
+++ b/python-eris-api.spec
@@ -0,0 +1,784 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-eris-api
+Version:	1.5.1
+Release:	1
+Summary:	please add a summary manually as the author left a blank one
+License:	MIT
+URL:		https://pypi.org/project/eris-api/
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/84/ac/dbeaca9cc5a76f6a8312c3e2543c04e39a6a53ef5137911c9e079fec9d74/ERIS-API-1.5.1.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-requests
+Requires:	python3-pandas
+Requires:	python3-pydantic
+Requires:	python3-xmltodict
+
+%description
+# ERIS API
+
+## About
+Package to wrap the ERIS API.
+
+Intended use is to simplify requesting data from ERIS.
+
+To proceed the user must be added to the API group and you must also know the client ID of the group.
+
+# Install
+
+```
+pip install ERIS-API
+```
+
+# Usage
+
+Basic flow is as follows. Example is also below:
+
+1. Create ERISAPI Class with following parameters
+    1. URL to ERIS. Include the trailing slash "https://www.eris.com/"
+    1. Client ID
+    1. Username
+    1. Password or Token
+
+you may choose to omit the username/password/token if they are set in your environment variables as eris_username/etc.
+    
+2. Build Tag list
+    1. Each tag should be an instance of the `ERISTag` class
+
+3. Build Request Class
+    1. provide the start time, end time and either the single tag, or a list of tags
+
+4. call `request_api_data` method with request class
+    1. the response will be an `ERISResponse` class.
+
+## Authorization
+
+To authorize the request you need to supply a `username` and one of `password` or `token`, in addition to the `client_id`.
+
+If both a password and a token are supplied, it will default to the password.
+
+### Example
+```
+from ERIS_API import ERISAPI, ERISTag, ERISRequest
+import datetime
+
+start_time = datetime.datetime(2021,1,1)
+end_time = datetime.datetime(2021,2,1)
+
+input_tags = [
+    ERISTag(label="sample label", tag="sampletag", mode="average", interval="P1D"),
+    ERISTag(label="sample label 2", tag="sampletag", mode="average", label="P2M"),
+]
+
+request_class = ERISRequest(
+    start_time=start_time,
+    end_time=end_time,
+    tags=input_tags
+)
+
+#password version
+api = ERISAPI(base_url="https://www.eris.com/", client_id="CLIENT_ID", username="USERNAME", password="PASSWORD")
+
+#token version
+api = ERISAPI(base_url="https://www.eris.com/", client_id="CLIENT_ID", username="USERNAME", token="TOKEN")
+
+result = api.request_api_data(request_class)
+```
+
+## Working with the response
+
+Once you have a valid response, the response class can be used to parse the data into either a json string or a pandas dataframe.
+
+Additionally, the response class will also contain additional information such as eng. units, tagUID, description, etc. Look at the ERIS_Response.py class for details.
+
+Within the response object there is the following properties:
+
+1. tag_data
+    * this is the processed tag, which contains additional information. Type is a dictionary.
+2. tag_dataframes
+    * This is the collection of tags converted to dataframes. 
+    * Columns are `Timestamp,Tag,Value`
+3. response_class
+    * raw response class from request
+    * this contains the original response content
+
+Finally, the response will attempt to process the `Timestamp` to a python datetime friendly format, rounding to the nearest second. It will also try and parse the `Value` to a numeric value.
+If this fails it will remain as exported.
+
+This can be ignored by setting parse_datetime or parse_values to False in the `convert_tags_to_dataframes` function.
+
+### Example
+
+```
+# continuing from above.
+result = api.request_api_data(request_class)
+
+# for one tag - change index to particular tag
+tag_df = result.tag_to_dataframe(result.tag_data[0])
+
+# can also specify which dictionary key to use (see the Response class) or a custom label. Will use custom label if both are given.
+tag_df = result.tag_to_dataframe(result.tag_data[0], custom_label="Custom Tag")
+
+# for all tags - concat argument will return either a single dataframe if True, or a list of individual tag dataframes if False
+
+# combined
+tag_df = result.convert_tags_to_dataframes(True)
+
+# individual
+tag_dfs = result.convert_tags_to_dataframes(False) 
+```
+
+## Concurrent Requests
+
+It is also possible to make the data requests concurrently.
+
+It follows the same api as above, but uses the `request_api_data_concurrent` function instead. Additional parameters of `delta` and `workers` is also accepted.
+
+* `delta`: specifies the window to apply to the concurrent requests in days. Default is 30 -> window of 30 days per-request
+* `workers`: number of workers to distribute the tasks to. Default is 8.
+
+concurrent request will return a list of `ERISResponses`. You should either iterate and call `convert_tags_to_dataframes` on each result, and then append to a dataframe with `pd.concat`, or use the `ERIS_API.combine_concurrent_results` function to combine the results
+
+```
+# continuing from above.
+result = api.request_api_data_concurrent(request_class, delta=7)
+
+df = api.combine_concurrent_results(result)
+
+```
+
+
+
+
+## Generic Request
+
+To optionally pass a generic url to an eris endpoint use the `ERISAPI.request_data` function.
+
+The function accepts a url and a dictionary of parameters. This is a generic wrapper around the `requests.get` function which takes care of the authentication step.
+
+```
+api = ERISAPI(url, username, password, client_id)
+api.request_data("/tag/list", parameters={})
+```
+
+## Next Steps
+
+You, the user, can decide how to work with the output data from here. Either saving the dataframe(s) to excel, csv, or loading it into an SQL database.
+
+## Query Improvements
+
+To improve query performance, your script should adjust the start date to the start/end times after any existing data to avoid re-requesting the same block.
+
+# Additional Functions
+
+## Extract Tag from  URL
+
+If you have the URL of the tag, you can extract the components of the query via the method `extract_tags_from_url`
+
+Calling this method will return a JSON String of the contents of the dictionary.
+
+```
+from ERIS_API import extract_tags_from_url
+
+input_url = "https://eris.com/api/rest/tag/data?start=2021-03-29T00:00:00&end=P1M3D&tags=sample_label:sample.tag:first:PT2M"
+
+extract_tags_from_url(input_url)
+
+# RESULT
+{
+    "start": [
+        "2021-03-29T00:00:00"
+    ],
+    "end": [
+        "P1M3D"
+    ],
+    "tags": [
+        {
+            "label": "sample_label",
+            "tag": "sample.tag",
+            "mode": "first",
+            "interval": "PT2M"
+        }
+    ]
+}
+```
+
+## JSON to Tag
+
+Method to convert a .json file of your tag list to a list of ERISTags
+
+Input is either 
+* `json_dict`: pre-loaded dictionary of your tags
+* `json_file`: file path to a json dictionary in the structure below
+
+### JSON Structure
+```
+[
+    {
+        "label": "lbl_value",
+        "tag": "tag_value",
+        "mode": "raw",
+        "interval": "P1D"
+    },
+    {
+        "label": "lbl_value2",
+        "tag": "tag_value2",
+        "mode": "raw",
+        "interval": "P1D"
+    }
+]
+```
+
+### Usage
+```
+from ERIS_API import json_to_tags
+
+json_dict = [
+    {
+        "label": "lbl_value",
+        "tag": "tag_value",
+        "mode": "raw",
+        "interval": "P1D"
+    },
+    {
+        "label": "lbl_value2",
+        "tag": "tag_value2",
+        "mode": "raw",
+        "interval": "P1D"
+    }
+]
+json_path = "eris_tags.json"
+
+tags = json_to_tags(json_dict=json_dict)
+tags = json_to_tags(json_path=json_path)
+```
+
+%package -n python3-eris-api
+Summary:	please add a summary manually as the author left a blank one
+Provides:	python-eris-api
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-eris-api
+# ERIS API
+
+## About
+Package to wrap the ERIS API.
+
+Intended use is to simplify requesting data from ERIS.
+
+To proceed the user must be added to the API group and you must also know the client ID of the group.
+
+# Install
+
+```
+pip install ERIS-API
+```
+
+# Usage
+
+Basic flow is as follows. Example is also below:
+
+1. Create ERISAPI Class with following parameters
+    1. URL to ERIS. Include the trailing slash "https://www.eris.com/"
+    1. Client ID
+    1. Username
+    1. Password or Token
+
+you may choose to omit the username/password/token if they are set in your environment variables as eris_username/etc.
+    
+2. Build Tag list
+    1. Each tag should be an instance of the `ERISTag` class
+
+3. Build Request Class
+    1. provide the start time, end time and either the single tag, or a list of tags
+
+4. call `request_api_data` method with request class
+    1. the response will be an `ERISResponse` class.
+
+## Authorization
+
+To authorize the request you need to supply a `username` and one of `password` or `token`, in addition to the `client_id`.
+
+If both a password and a token are supplied, it will default to the password.
+
+### Example
+```
+from ERIS_API import ERISAPI, ERISTag, ERISRequest
+import datetime
+
+start_time = datetime.datetime(2021,1,1)
+end_time = datetime.datetime(2021,2,1)
+
+input_tags = [
+    ERISTag(label="sample label", tag="sampletag", mode="average", interval="P1D"),
+    ERISTag(label="sample label 2", tag="sampletag", mode="average", label="P2M"),
+]
+
+request_class = ERISRequest(
+    start_time=start_time,
+    end_time=end_time,
+    tags=input_tags
+)
+
+#password version
+api = ERISAPI(base_url="https://www.eris.com/", client_id="CLIENT_ID", username="USERNAME", password="PASSWORD")
+
+#token version
+api = ERISAPI(base_url="https://www.eris.com/", client_id="CLIENT_ID", username="USERNAME", token="TOKEN")
+
+result = api.request_api_data(request_class)
+```
+
+## Working with the response
+
+Once you have a valid response, the response class can be used to parse the data into either a json string or a pandas dataframe.
+
+Additionally, the response class will also contain additional information such as eng. units, tagUID, description, etc. Look at the ERIS_Response.py class for details.
+
+Within the response object there is the following properties:
+
+1. tag_data
+    * this is the processed tag, which contains additional information. Type is a dictionary.
+2. tag_dataframes
+    * This is the collection of tags converted to dataframes. 
+    * Columns are `Timestamp,Tag,Value`
+3. response_class
+    * raw response class from request
+    * this contains the original response content
+
+Finally, the response will attempt to process the `Timestamp` to a python datetime friendly format, rounding to the nearest second. It will also try and parse the `Value` to a numeric value.
+If this fails it will remain as exported.
+
+This can be ignored by setting parse_datetime or parse_values to False in the `convert_tags_to_dataframes` function.
+
+### Example
+
+```
+# continuing from above.
+result = api.request_api_data(request_class)
+
+# for one tag - change index to particular tag
+tag_df = result.tag_to_dataframe(result.tag_data[0])
+
+# can also specify which dictionary key to use (see the Response class) or a custom label. Will use custom label if both are given.
+tag_df = result.tag_to_dataframe(result.tag_data[0], custom_label="Custom Tag")
+
+# for all tags - concat argument will return either a single dataframe if True, or a list of individual tag dataframes if False
+
+# combined
+tag_df = result.convert_tags_to_dataframes(True)
+
+# individual
+tag_dfs = result.convert_tags_to_dataframes(False) 
+```
+
+## Concurrent Requests
+
+It is also possible to make the data requests concurrently.
+
+It follows the same api as above, but uses the `request_api_data_concurrent` function instead. Additional parameters of `delta` and `workers` is also accepted.
+
+* `delta`: specifies the window to apply to the concurrent requests in days. Default is 30 -> window of 30 days per-request
+* `workers`: number of workers to distribute the tasks to. Default is 8.
+
+concurrent request will return a list of `ERISResponses`. You should either iterate and call `convert_tags_to_dataframes` on each result, and then append to a dataframe with `pd.concat`, or use the `ERIS_API.combine_concurrent_results` function to combine the results
+
+```
+# continuing from above.
+result = api.request_api_data_concurrent(request_class, delta=7)
+
+df = api.combine_concurrent_results(result)
+
+```
+
+
+
+
+## Generic Request
+
+To optionally pass a generic url to an eris endpoint use the `ERISAPI.request_data` function.
+
+The function accepts a url and a dictionary of parameters. This is a generic wrapper around the `requests.get` function which takes care of the authentication step.
+
+```
+api = ERISAPI(url, username, password, client_id)
+api.request_data("/tag/list", parameters={})
+```
+
+## Next Steps
+
+You, the user, can decide how to work with the output data from here. Either saving the dataframe(s) to excel, csv, or loading it into an SQL database.
+
+## Query Improvements
+
+To improve query performance, your script should adjust the start date to the start/end times after any existing data to avoid re-requesting the same block.
+
+# Additional Functions
+
+## Extract Tag from  URL
+
+If you have the URL of the tag, you can extract the components of the query via the method `extract_tags_from_url`
+
+Calling this method will return a JSON String of the contents of the dictionary.
+
+```
+from ERIS_API import extract_tags_from_url
+
+input_url = "https://eris.com/api/rest/tag/data?start=2021-03-29T00:00:00&end=P1M3D&tags=sample_label:sample.tag:first:PT2M"
+
+extract_tags_from_url(input_url)
+
+# RESULT
+{
+    "start": [
+        "2021-03-29T00:00:00"
+    ],
+    "end": [
+        "P1M3D"
+    ],
+    "tags": [
+        {
+            "label": "sample_label",
+            "tag": "sample.tag",
+            "mode": "first",
+            "interval": "PT2M"
+        }
+    ]
+}
+```
+
+## JSON to Tag
+
+Method to convert a .json file of your tag list to a list of ERISTags
+
+Input is either 
+* `json_dict`: pre-loaded dictionary of your tags
+* `json_file`: file path to a json dictionary in the structure below
+
+### JSON Structure
+```
+[
+    {
+        "label": "lbl_value",
+        "tag": "tag_value",
+        "mode": "raw",
+        "interval": "P1D"
+    },
+    {
+        "label": "lbl_value2",
+        "tag": "tag_value2",
+        "mode": "raw",
+        "interval": "P1D"
+    }
+]
+```
+
+### Usage
+```
+from ERIS_API import json_to_tags
+
+json_dict = [
+    {
+        "label": "lbl_value",
+        "tag": "tag_value",
+        "mode": "raw",
+        "interval": "P1D"
+    },
+    {
+        "label": "lbl_value2",
+        "tag": "tag_value2",
+        "mode": "raw",
+        "interval": "P1D"
+    }
+]
+json_path = "eris_tags.json"
+
+tags = json_to_tags(json_dict=json_dict)
+tags = json_to_tags(json_path=json_path)
+```
+
+%package help
+Summary:	Development documents and examples for eris-api
+Provides:	python3-eris-api-doc
+%description help
+# ERIS API
+
+## About
+Package to wrap the ERIS API.
+
+Intended use is to simplify requesting data from ERIS.
+
+To proceed the user must be added to the API group and you must also know the client ID of the group.
+
+# Install
+
+```
+pip install ERIS-API
+```
+
+# Usage
+
+Basic flow is as follows. Example is also below:
+
+1. Create ERISAPI Class with following parameters
+    1. URL to ERIS. Include the trailing slash "https://www.eris.com/"
+    1. Client ID
+    1. Username
+    1. Password or Token
+
+you may choose to omit the username/password/token if they are set in your environment variables as eris_username/etc.
+    
+2. Build Tag list
+    1. Each tag should be an instance of the `ERISTag` class
+
+3. Build Request Class
+    1. provide the start time, end time and either the single tag, or a list of tags
+
+4. call `request_api_data` method with request class
+    1. the response will be an `ERISResponse` class.
+
+## Authorization
+
+To authorize the request you need to supply a `username` and one of `password` or `token`, in addition to the `client_id`.
+
+If both a password and a token are supplied, it will default to the password.
+
+### Example
+```
+from ERIS_API import ERISAPI, ERISTag, ERISRequest
+import datetime
+
+start_time = datetime.datetime(2021,1,1)
+end_time = datetime.datetime(2021,2,1)
+
+input_tags = [
+    ERISTag(label="sample label", tag="sampletag", mode="average", interval="P1D"),
+    ERISTag(label="sample label 2", tag="sampletag", mode="average", label="P2M"),
+]
+
+request_class = ERISRequest(
+    start_time=start_time,
+    end_time=end_time,
+    tags=input_tags
+)
+
+#password version
+api = ERISAPI(base_url="https://www.eris.com/", client_id="CLIENT_ID", username="USERNAME", password="PASSWORD")
+
+#token version
+api = ERISAPI(base_url="https://www.eris.com/", client_id="CLIENT_ID", username="USERNAME", token="TOKEN")
+
+result = api.request_api_data(request_class)
+```
+
+## Working with the response
+
+Once you have a valid response, the response class can be used to parse the data into either a json string or a pandas dataframe.
+
+Additionally, the response class will also contain additional information such as eng. units, tagUID, description, etc. Look at the ERIS_Response.py class for details.
+
+Within the response object there is the following properties:
+
+1. tag_data
+    * this is the processed tag, which contains additional information. Type is a dictionary.
+2. tag_dataframes
+    * This is the collection of tags converted to dataframes. 
+    * Columns are `Timestamp,Tag,Value`
+3. response_class
+    * raw response class from request
+    * this contains the original response content
+
+Finally, the response will attempt to process the `Timestamp` to a python datetime friendly format, rounding to the nearest second. It will also try and parse the `Value` to a numeric value.
+If this fails it will remain as exported.
+
+This can be ignored by setting parse_datetime or parse_values to False in the `convert_tags_to_dataframes` function.
+
+### Example
+
+```
+# continuing from above.
+result = api.request_api_data(request_class)
+
+# for one tag - change index to particular tag
+tag_df = result.tag_to_dataframe(result.tag_data[0])
+
+# can also specify which dictionary key to use (see the Response class) or a custom label. Will use custom label if both are given.
+tag_df = result.tag_to_dataframe(result.tag_data[0], custom_label="Custom Tag")
+
+# for all tags - concat argument will return either a single dataframe if True, or a list of individual tag dataframes if False
+
+# combined
+tag_df = result.convert_tags_to_dataframes(True)
+
+# individual
+tag_dfs = result.convert_tags_to_dataframes(False) 
+```
+
+## Concurrent Requests
+
+It is also possible to make the data requests concurrently.
+
+It follows the same api as above, but uses the `request_api_data_concurrent` function instead. Additional parameters of `delta` and `workers` is also accepted.
+
+* `delta`: specifies the window to apply to the concurrent requests in days. Default is 30 -> window of 30 days per-request
+* `workers`: number of workers to distribute the tasks to. Default is 8.
+
+concurrent request will return a list of `ERISResponses`. You should either iterate and call `convert_tags_to_dataframes` on each result, and then append to a dataframe with `pd.concat`, or use the `ERIS_API.combine_concurrent_results` function to combine the results
+
+```
+# continuing from above.
+result = api.request_api_data_concurrent(request_class, delta=7)
+
+df = api.combine_concurrent_results(result)
+
+```
+
+
+
+
+## Generic Request
+
+To optionally pass a generic url to an eris endpoint use the `ERISAPI.request_data` function.
+
+The function accepts a url and a dictionary of parameters. This is a generic wrapper around the `requests.get` function which takes care of the authentication step.
+
+```
+api = ERISAPI(url, username, password, client_id)
+api.request_data("/tag/list", parameters={})
+```
+
+## Next Steps
+
+You, the user, can decide how to work with the output data from here. Either saving the dataframe(s) to excel, csv, or loading it into an SQL database.
+
+## Query Improvements
+
+To improve query performance, your script should adjust the start date to the start/end times after any existing data to avoid re-requesting the same block.
+
+# Additional Functions
+
+## Extract Tag from  URL
+
+If you have the URL of the tag, you can extract the components of the query via the method `extract_tags_from_url`
+
+Calling this method will return a JSON String of the contents of the dictionary.
+
+```
+from ERIS_API import extract_tags_from_url
+
+input_url = "https://eris.com/api/rest/tag/data?start=2021-03-29T00:00:00&end=P1M3D&tags=sample_label:sample.tag:first:PT2M"
+
+extract_tags_from_url(input_url)
+
+# RESULT
+{
+    "start": [
+        "2021-03-29T00:00:00"
+    ],
+    "end": [
+        "P1M3D"
+    ],
+    "tags": [
+        {
+            "label": "sample_label",
+            "tag": "sample.tag",
+            "mode": "first",
+            "interval": "PT2M"
+        }
+    ]
+}
+```
+
+## JSON to Tag
+
+Method to convert a .json file of your tag list to a list of ERISTags
+
+Input is either 
+* `json_dict`: pre-loaded dictionary of your tags
+* `json_file`: file path to a json dictionary in the structure below
+
+### JSON Structure
+```
+[
+    {
+        "label": "lbl_value",
+        "tag": "tag_value",
+        "mode": "raw",
+        "interval": "P1D"
+    },
+    {
+        "label": "lbl_value2",
+        "tag": "tag_value2",
+        "mode": "raw",
+        "interval": "P1D"
+    }
+]
+```
+
+### Usage
+```
+from ERIS_API import json_to_tags
+
+json_dict = [
+    {
+        "label": "lbl_value",
+        "tag": "tag_value",
+        "mode": "raw",
+        "interval": "P1D"
+    },
+    {
+        "label": "lbl_value2",
+        "tag": "tag_value2",
+        "mode": "raw",
+        "interval": "P1D"
+    }
+]
+json_path = "eris_tags.json"
+
+tags = json_to_tags(json_dict=json_dict)
+tags = json_to_tags(json_path=json_path)
+```
+
+%prep
+%autosetup -n eris-api-1.5.1
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-eris-api -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 1.5.1-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..051093e
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+8e1a2406ef4e79dcff36936900202d79  ERIS-API-1.5.1.tar.gz