load credentials from .env file

Author: michaelmattig

.gitignore

@@ -16,3 +16,4 @@ env
 
 # Private files
 .pypirc
+.env

README.md

@@ -1,6 +1,5 @@
 # Geo Engine Python Package
 
-
 [![CI](https://github.com/geo-engine/geoengine-python/actions/workflows/ci.yml/badge.svg)](https://github.com/geo-engine/geoengine-python/actions/workflows/ci.yml)
 
 This package allows easy access to Geo Engine functionality from Python environments.
@@ -101,3 +100,16 @@ print(workflow.get_result_descriptor())
 
 workflow.get_dataframe(ge.Bbox([-60.0, 5.0, 61.0, 6.0], [time, time]))
 ```
+
+## Authentication
+
+If the Geo Engine server requires authentication, you can set your credentials in the following ways:
+
+1. in the initialize method: `ge.initialize("http://peter.geoengine.io:6060", ("email", "password"))`
+2. as environment variables `export GEOENGINE_EMAIL="email"` and `export GEOENGINE_PASSWORD="password"`
+3. in a .env file in the current working directory with the content:
+
+```bash
+GEOENGINE_EMAIL="email"
+GEOENGINE_PASSWORD="password"
+```

geoengine/auth.py

@@ -6,6 +6,7 @@
 from uuid import UUID
 
 import os
+from dotenv import load_dotenv
 import requests as req
 from requests.auth import AuthBase
 
@@ -129,8 +130,11 @@ def initialize(server_url: str, credentials: Tuple[str, str] = None) -> None:
 
     optional arugments: (email, password) as tuple
     optional environment variables: GEOENGINE_EMAIL, GEOENGINE_PASSWORD
+    optional .env file defining: GEOENGINE_EMAIL, GEOENGINE_PASSWORD
     '''
 
+    load_dotenv()
+
     Session.session = Session(server_url, credentials)
 
 

setup.cfg

@@ -25,6 +25,7 @@ install_requires =
     owslib
     pillow
     pyepsg # for cartopy
+    python-dotenv
     rasterio
     requests
     scipy # for cartopy