Use google static keys properly this time (#244)

.github/workflows/run-tests.yml

@@ -51,6 +51,7 @@ jobs:
         env:
           MPLBACKEND: agg
           COVERAGE_RCFILE: ${{ github.workspace }}/.coveragerc
+          STATIC_MAP_API_KEY: ${{ secrets.STATIC_MAP_API_KEY }}
       - name: Upload Coverage
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -5,6 +5,7 @@ savefig
 .eggs
 dist/
 sg_execution_times.rst
+.env
 
 # PyCharm stuffs
 .idea/

docs/examples/plot_googlestatic.py

@@ -32,6 +32,7 @@
 shp = salem.read_shapefile(get_demo_file('rgi_kesselwand.shp'))
 # I you need to do a lot of maps you might want
 # to use an API key and set it here with key='YOUR_API_KEY'
+# or set it in your environment as STATIC_MAP_API_KEY
 g = GoogleVisibleMap(x=[shp.min_x, shp.max_x], y=[shp.min_y, shp.max_y],
                      scale=2,  # scale is for more details
                      maptype='satellite')  # try out also: 'terrain'

salem/__init__.py

@@ -39,7 +39,7 @@ def _lazy_property(self):
 if not path.exists(download_dir):
     makedirs(download_dir)
 
-sample_data_gh_commit = '57e6d694aa470b967336f5ca2d4fc743c5c8efd6'
+sample_data_gh_commit = '454bf696324000d198f574a1bf5bc56e3e489051'
 sample_data_dir = path.join(cache_dir, 'salem-sample-data-' +
                             sample_data_gh_commit)
 

salem/datasets.py

@@ -31,8 +31,6 @@
 from salem import wgs84
 from salem import utils, gis, wrftools, sio, check_crs
 
-API_KEY = None
-
 
 class GeoDataset(object):
     """Interface for georeferenced datasets.
@@ -482,11 +480,14 @@ class GoogleCenterMap(GeoDataset):
     """Google static map centered on a point.
 
     Needs motionless.
+
+    See https://developers.google.com/maps/documentation/maps-static/usage-and-billing
+    for pricing.
     """
 
     def __init__(self, center_ll=(11.38, 47.26), size_x=640, size_y=640,
                  scale=1, zoom=12, maptype='satellite', use_cache=True,
-                 **kwargs):
+                 key=None, **kwargs):
         """Initialize
 
         Parameters
@@ -507,28 +508,32 @@ def __init__(self, center_ll=(11.38, 47.26), size_x=640, size_y=640,
           'roadmap', 'satellite', 'hybrid', 'terrain'
         use_cache : bool, default: True
           store the downloaded image in the cache to avoid future downloads
+        key : str, default: None
+          Google API key. If None, it will try to read it from
+          the environment variable STATIC_MAP_API_KEY
         kwargs : **
-          any keyword accepted by motionless.CenterMap (e.g. `key` for the API)
+          any keyword accepted by motionless.CenterMap
         """
 
-        global API_KEY
-
         # Google grid
         grid = gis.googlestatic_mercator_grid(center_ll=center_ll,
                                               nx=size_x, ny=size_y,
                                               zoom=zoom, scale=scale)
 
-        if 'key' not in kwargs:
-            if API_KEY is None:
-                with open(utils.get_demo_file('.api_key'), 'r') as f:
-                    API_KEY = f.read().replace('\n', '')
-            kwargs['key'] = API_KEY
+        if key is None:
+            try:
+                key = os.environ['STATIC_MAP_API_KEY']
+            except KeyError:
+                raise ValueError('You need to provide a Google API key'
+                                 ' or set the STATIC_MAP_API_KEY environment'
+                                 ' variable.')
 
         # Motionless
         import motionless
         googleurl = motionless.CenterMap(lon=center_ll[0], lat=center_ll[1],
                                          size_x=size_x, size_y=size_y,
-                                         maptype=maptype, zoom=zoom, scale=scale,
+                                         maptype=maptype, zoom=zoom,
+                                         scale=scale, key=key,
                                          **kwargs)
 
         # done
@@ -556,10 +561,13 @@ class GoogleVisibleMap(GoogleCenterMap):
     """Google static map automatically sized and zoomed to a selected region.
 
     It's usually more practical to use than GoogleCenterMap.
+
+    See https://developers.google.com/maps/documentation/maps-static/usage-and-billing
+    for pricing.
     """
 
     def __init__(self, x, y, crs=wgs84, size_x=640, size_y=640, scale=1,
-                 maptype='satellite', use_cache=True, **kwargs):
+                 maptype='satellite', use_cache=True, key=None, **kwargs):
         """Initialize
 
         Parameters
@@ -581,6 +589,9 @@ def __init__(self, x, y, crs=wgs84, size_x=640, size_y=640, scale=1,
           'roadmap', 'satellite', 'hybrid', 'terrain'
         use_cache : bool, default: True
           store the downloaded image in the cache to avoid future downloads
+        key : str, default: None
+          Google API key. If None, it will try to read it from
+          the environment variable STATIC_MAP_API_KEY
         kwargs : **
           any keyword accepted by motionless.CenterMap (e.g. `key` for the API)
 
@@ -590,7 +601,13 @@ def __init__(self, x, y, crs=wgs84, size_x=640, size_y=640, scale=1,
         play with the `size_x` and `size_y` kwargs.
         """
 
-        global API_KEY
+        if key is None:
+            try:
+                key = os.environ['STATIC_MAP_API_KEY']
+            except KeyError:
+                raise ValueError('You need to provide a Google API key'
+                                 ' or set the STATIC_MAP_API_KEY environment'
+                                 ' variable.')
 
         if 'zoom' in kwargs or 'center_ll' in kwargs:
             raise ValueError('incompatible kwargs.')
@@ -617,12 +634,7 @@ def __init__(self, x, y, crs=wgs84, size_x=640, size_y=640, scale=1,
             else:
                 break
 
-        if 'key' not in kwargs:
-            if API_KEY is None:
-                with open(utils.get_demo_file('.api_key'), 'r') as f:
-                    API_KEY = f.read().replace('\n', '')
-            kwargs['key'] = API_KEY
-
         GoogleCenterMap.__init__(self, center_ll=mc, size_x=size_x,
                                  size_y=size_y, zoom=zoom, scale=scale,
-                                 maptype=maptype, use_cache=use_cache, **kwargs)
+                                 maptype=maptype, use_cache=use_cache,
+                                 key=key, **kwargs)

salem/tests/test_misc.py

@@ -843,7 +843,7 @@ def test_mf_datasets(self):
         dsm.to_netcdf(fo)
         dsm.close()
         dsm = sio.open_wrf_dataset(fo)
-        assert_allclose(ds['PRCP'], dsm['PRCP'])
+        assert_allclose(ds['PRCP'], dsm['PRCP'], rtol=1e-6)
         assert_allclose(prcp_nc, dsm['PRCP_NC'].isel(time=slice(1, 4)),
                         rtol=1e-6)