Merge pull request #15 from SheffieldSolar/v3_to_v4

v0.11

Dockerfile

@@ -10,7 +10,7 @@ RUN apt-get -qq update && apt-get -qq install -y \
     wget \
     > /dev/null
 
-RUN pip install --no-cache-dir git+https://github.com/SheffieldSolar/PV_Live-API.git@0.10 > /dev/null
+RUN pip install --no-cache-dir git+https://github.com/SheffieldSolar/PV_Live-API.git@0.11 > /dev/null
 
 #RUN pip install --no-cache-dir -r /pv_live/requirements.txt > /dev/null
 #COPY . /pv_live/

README.md

@@ -2,9 +2,9 @@
 # PV_Live
 A Python implementation of the PV_Live web API. See https://www.solar.sheffield.ac.uk/pvlive/
 
-**Latest Version: 0.10**
+**Latest Version: 0.11**
 
-**New! Updated 2021-09-09 to include support for accessing 5 minutely PV_Live outturns.**
+**New! Updated 2022-07-19 to use the v4 PV_Live API.**
 
 ## About this repository
 

Tests/test_pvlive_api.py

@@ -125,103 +125,95 @@ def test_latest(self):
 
     def test_day_peak(self):
         """Tests the day_peak function."""
-        data = self.api.day_peak(d=date(2018, 6, 3), entity_type="pes", entity_id=0)
+        data = self.api.day_peak(d=date(2022, 7, 19), entity_type="pes", entity_id=0)
         self.check_pes_tuple(data)
         self.check_pes_tuple_dtypes(data)
-        data = self.api.day_peak(d=date(2018, 6, 3), entity_type="pes", entity_id=0, dataframe=True)
+        data = self.api.day_peak(d=date(2022, 7, 19), entity_type="pes", entity_id=0, dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
-        data = self.api.day_peak(d=date(2018, 6, 3),
+        data = self.api.day_peak(d=date(2022, 7, 19),
                                  extra_fields="ucl_mw,lcl_mw,installedcapacity_mwp,stats_error",
                                  entity_type="pes", entity_id=0, dataframe=True)
-        data = self.api.day_peak(d=date(2021, 5, 1), entity_type="pes", entity_id=0, period=5)
+        data = self.api.day_peak(d=date(2022, 7, 19), entity_type="pes", entity_id=0, period=5)
         self.check_pes_tuple(data)
         self.check_pes_tuple_dtypes(data)
-        data = self.api.day_peak(d=date(2021, 5, 1), entity_type="pes", entity_id=0, period=5,
+        data = self.api.day_peak(d=date(2022, 7, 19), entity_type="pes", entity_id=0, period=5,
                                  dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
-        data = self.api.day_peak(d=date(2021, 5, 1),
+        data = self.api.day_peak(d=date(2022, 7, 19),
                                  extra_fields="ucl_mw,lcl_mw,installedcapacity_mwp,stats_error",
                                  entity_type="pes", entity_id=0, period=5, dataframe=True)
         self.check_df_dtypes(data)
-        data = self.api.day_peak(d=date(2018, 6, 3), entity_type="gsp", entity_id=54)
+        data = self.api.day_peak(d=date(2022, 7, 19), entity_type="gsp", entity_id=54)
         self.check_gsp_tuple(data)
         self.check_gsp_tuple_dtypes(data)
-        data = self.api.day_peak(d=date(2018, 6, 3), entity_type="gsp", entity_id=54,
+        data = self.api.day_peak(d=date(2022, 7, 19), entity_type="gsp", entity_id=54,
                                  dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
 
     def test_day_energy(self):
         """Tests the day_energy function."""
-        data = self.api.day_energy(d=date(2018, 6, 3), entity_type="pes", entity_id=0)
+        data = self.api.day_energy(d=date(2022, 7, 19), entity_type="pes", entity_id=0)
         assert isinstance(data, float)
 
     def test_between(self):
         """Test the between function."""
-        data = self.api.between(start=datetime(2018, 7, 3, 12, 20, tzinfo=pytz.utc),
-                                end=datetime(2018, 7, 3, 14, 00, tzinfo=pytz.utc),
+        data = self.api.between(start=datetime(2022, 7, 19, 12, 20, tzinfo=pytz.utc),
+                                end=datetime(2022, 7, 19, 14, 0, tzinfo=pytz.utc),
                                 entity_type="pes", entity_id=0)
         with self.subTest():
             assert isinstance(data, list)
-        data = self.api.between(start=datetime(2018, 7, 4, 12, 20, tzinfo=pytz.utc),
-                                end=datetime(2018, 7, 5, 14, 00, tzinfo=pytz.utc),
+        data = self.api.between(start=datetime(2022, 7, 19, 12, 20, tzinfo=pytz.utc),
+                                end=datetime(2022, 7, 19, 14, 0, tzinfo=pytz.utc),
                                 entity_type="pes", entity_id=0, dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
-        data = self.api.day_peak(d=date(2018, 6, 3),
-                                 extra_fields="ucl_mw,lcl_mw,installedcapacity_mwp,stats_error",
-                                 entity_type="pes", entity_id=0, dataframe=True)
-        self.check_df_dtypes(data)
-        data = self.api.between(start=datetime(2021, 5, 1, tzinfo=pytz.utc),
-                                end=datetime(2021, 5, 1, 14, 00, tzinfo=pytz.utc),
+        data = self.api.between(start=datetime(2022, 7, 19, tzinfo=pytz.utc),
+                                end=datetime(2022, 7, 19, 14, 00, tzinfo=pytz.utc),
                                 entity_type="pes", entity_id=0, period=5)
         with self.subTest():
             assert isinstance(data, list)
-        data = self.api.between(start=datetime(2021, 5, 1, 12, 20, tzinfo=pytz.utc),
-                                end=datetime(2021, 5, 1, 14, 00, tzinfo=pytz.utc),
+        data = self.api.between(start=datetime(2022, 7, 19, 12, 20, tzinfo=pytz.utc),
+                                end=datetime(2022, 7, 19, 14, 00, tzinfo=pytz.utc),
                                 entity_type="pes", entity_id=0, period=5, dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
-        data = self.api.day_peak(d=date(2021, 5, 1),
-                                  extra_fields="ucl_mw,lcl_mw,installedcapacity_mwp,stats_error",
-                                  entity_type="pes", entity_id=0, period=5, dataframe=True)
-        self.check_df_dtypes(data)
 
     def test_at_time(self):
         """Test the at_time function."""
-        data = self.api.at_time(dt=datetime(2018, 6, 3, 12, 35, tzinfo=pytz.utc), entity_type="pes",
+        data = self.api.at_time(dt=datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="pes",
                                             entity_id=0)
         self.check_pes_tuple(data)
         self.check_pes_tuple_dtypes(data)
-        data = self.api.at_time(datetime(2018, 6, 3, 12, 35, tzinfo=pytz.utc), entity_type="pes",
+        data = self.api.at_time(datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="pes",
                                 entity_id=0, dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
-        data = self.api.at_time(datetime(2018, 7, 3, 12, 35, tzinfo=pytz.utc), entity_type="pes",
+        data = self.api.at_time(datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="pes",
                                 entity_id=0,
                                 extra_fields="ucl_mw,lcl_mw,installedcapacity_mwp,stats_error",
                                 dataframe=True)
         self.check_df_dtypes(data)
-        data = self.api.at_time(dt=datetime(2021, 5, 1, 12, 35, tzinfo=pytz.utc), entity_type="pes",
+        data = self.api.at_time(dt=datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="pes",
                                             entity_id=0, period=5)
         self.check_pes_tuple(data)
         self.check_pes_tuple_dtypes(data)
-        data = self.api.at_time(datetime(2021, 5, 1, 12, 35, tzinfo=pytz.utc), entity_type="pes",
+        data = self.api.at_time(datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="pes",
                                 entity_id=0, period=5, dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)
-        data = self.api.at_time(datetime(2021, 5, 1, 12, 35, tzinfo=pytz.utc), entity_type="pes",
+        data = self.api.at_time(datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="pes",
                                 entity_id=0,
                                 extra_fields="ucl_mw,lcl_mw,installedcapacity_mwp,stats_error",
                                 period=5, dataframe=True)
         self.check_df_dtypes(data)
-        data = self.api.at_time(dt=datetime(2018, 6, 3, 12, 35, tzinfo=pytz.utc), entity_type="gsp",
+        data = self.api.at_time(dt=datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="gsp",
                                 entity_id=26)
         self.check_gsp_tuple(data)
         self.check_gsp_tuple_dtypes(data)
-        data = self.api.at_time(datetime(2018, 6, 3, 12, 35, tzinfo=pytz.utc), entity_type="gsp",
+        data = self.api.at_time(datetime(2022, 7, 19, 12, 35, tzinfo=pytz.utc), entity_type="gsp",
                                          entity_id=26, dataframe=True)
         self.check_df_columns(data)
         self.check_df_dtypes(data)

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 63562d0c06e8115eb2c773d0b286b9a2
+config: cb2a6bc7fffba35f31ac94855737b628
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.10',
+    VERSION: '0.11',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/build/html/genindex.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; PV_Live API 0.10 documentation</title>
+    <title>Index &#8212; PV_Live API 0.11 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">PV_Live API 0.10 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PV_Live API 0.11 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>  
@@ -153,7 +153,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">PV_Live API 0.10 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PV_Live API 0.11 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>

docs/build/html/index.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
 
-    <title>Welcome to PV_Live API’s documentation! &#8212; PV_Live API 0.10 documentation</title>
+    <title>Welcome to PV_Live API’s documentation! &#8212; PV_Live API 0.11 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="modules.html" title="Modules"
              accesskey="N">next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">PV_Live API 0.10 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">PV_Live API 0.11 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Welcome to PV_Live API’s documentation!</a></li> 
       </ul>
     </div>  
@@ -112,7 +112,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="modules.html" title="Modules"
              >next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">PV_Live API 0.10 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">PV_Live API 0.11 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Welcome to PV_Live API’s documentation!</a></li> 
       </ul>
     </div>