Merge pull request #170 from EJEP/tidy_id_and_api_key

Tidy id and api key

Author: Emlyn Price

CHANGELOG.md

@@ -7,11 +7,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 + Remove deprecated `new_old` and `future_old` functions.
 + Add `__str__` functions to `Timestep`, `Element`, `Day`, `Site`
 + Add element to `Forecast` to track if forecast is daily or 3 hourly
++ Change `id` variable in `Forecast`, `Observation`, `Site` to `location_id`.
++ Change `id` variable in `Element` to `field_code`.
 
 ## [0.9.8] - 2020-07-03
 
 + Remove f-string in test
-
+  
 ## [0.9.7] - 2020-07-03
 
 + Bugfix for `get_observation_sites`
@@ -141,4 +143,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [0.1] - 2014-07-16
 
-+ Initial commit and license.
+    + Initial commit and license.

README.md

@@ -46,7 +46,7 @@ conn = datapoint.connection(api_key="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
 site = conn.get_nearest_forecast_site(51.500728, -0.124626)
 
 # Get a forecast for my nearest site with 3 hourly timesteps
-forecast = conn.get_forecast_for_site(site.id, "3hourly")
+forecast = conn.get_forecast_for_site(site.location_id, "3hourly")
 
 # Get the current timestep from the forecast
 current_timestep = forecast.now()

datapoint/Day.py

@@ -1,7 +1,5 @@
 class Day():
-    def __init__(self, api_key=""):
-        self.api_key = api_key
-
+    def __init__(self):
         self.date = None
         self.timesteps = []
 

datapoint/Element.py

@@ -1,7 +1,7 @@
 class Element():
-    def __init__(self, id=None, value=None, units=None):
+    def __init__(self, field_code=None, value=None, units=None):
 
-        self.id = id
+        self.field_code = field_code
         self.value = value
         self.units = units
 

datapoint/Forecast.py

@@ -3,17 +3,15 @@
 
 
 class Forecast():
-    def __init__(self, api_key="", frequency=""):
-        self.api_key = api_key
-
+    def __init__(self, frequency=""):
         self.frequency = frequency
         self.data_date = None
         self.continent = None
         self.country = None
         self.name = None
         self.longitude = None
         self.latitude = None
-        self.id = None
+        self.location_id = None
         self.elevation = None
         self.days = []
 

datapoint/Manager.py

@@ -247,7 +247,7 @@ def get_forecast_sites(self):
             for jsoned in data['Locations']['Location']:
                 site = Site()
                 site.name = jsoned['name']
-                site.id = jsoned['id']
+                site.location_id = jsoned['id']
                 site.latitude = jsoned['latitude']
                 site.longitude = jsoned['longitude']
 
@@ -359,7 +359,7 @@ def get_forecast_for_site(self, site_id, frequency="daily"):
             forecast.latitude = data['SiteRep']['DV']['Location']['lat']
 
         if 'i' in data['SiteRep']['DV']['Location']:
-            forecast.id = data['SiteRep']['DV']['Location']['i']
+            forecast.location_id = data['SiteRep']['DV']['Location']['i']
 
         if 'elevation' in data['SiteRep']['DV']['Location']:
             forecast.elevation = data['SiteRep']['DV']['Location']['elevation']
@@ -467,7 +467,7 @@ def get_observation_sites(self):
             for jsoned in data['Locations']['Location']:
                 site = Site()
                 site.name = jsoned['name']
-                site.id = jsoned['id']
+                site.location_id = jsoned['id']
                 site.latitude = jsoned['latitude']
                 site.longitude = jsoned['longitude']
 
@@ -553,7 +553,7 @@ def get_observations_for_site(self, site_id, frequency='hourly'):
                     observation.latitude = data['SiteRep']['DV']['Location']['lat']
 
                 if 'i' in data['SiteRep']['DV']['Location']:
-                    observation.id = data['SiteRep']['DV']['Location']['i']
+                    observation.location_id = data['SiteRep']['DV']['Location']['i']
 
                 if 'elevation' in data['SiteRep']['DV']['Location']:
                     observation.elevation = data['SiteRep']['DV']['Location']['elevation']

datapoint/Observation.py

@@ -1,23 +1,20 @@
-import datetime
-
 class Observation():
-    def __init__(self, api_key=""):
-        self.api_key = api_key
-
+    def __init__(self):
         self.data_date = None
         self.continent = None
         self.country = None
         self.name = None
         self.longitude = None
         self.latitude = None
-        self.id = None
+        self.location_id = None
         self.elevation = None
         # Stores a list of observations in days
         self.days = []
 
     def now(self):
         """
-        Return the final timestep available. This is the most recent observation.
+        Return the final timestep available. This is the most recent
+        observation.
         """
 
         return self.days[-1].timesteps[-1]

datapoint/Site.py

@@ -1,9 +1,7 @@
 class Site():
-    def __init__(self, api_key=""):
-        self.api_key = api_key
-
+    def __init__(self):
         self.name = None
-        self.id = None
+        self.location_id = None
         self.elevation = None
         self.latitude = None
         self.longitude = None

datapoint/Timestep.py

@@ -1,9 +1,7 @@
 from .Element import Element
 
 class Timestep():
-    def __init__(self, api_key=""):
-        self.api_key = api_key
-
+    def __init__(self):
         self.name = None
         self.date = None
         self.weather = None

datapoint/regions/RegionManager.py

@@ -50,7 +50,7 @@ def get_all_regions(self):
         regions = []
         for location in response['Locations']['Location']:
             region = Site()
-            region.id = location['@id']
+            region.location_id = location['@id']
             region.region = location['@name']
             region.name = REGION_NAMES[location['@name']]
             regions.append(region)