add Auth.value property to access auth information

Author: jreiberkyle

docs/guide.md

@@ -46,6 +46,8 @@ in `Auth.from_key()`.
 
 Once the authentication information is obtained, the most convenient way of
 managing it for local use is to write it to a secret file using `Auth.write()`.
+It can also be accessed, e.g. to store in an environment variable, as
+`Auth.value`.
 
 For example, to obtain and store authentication information:
 

planet/auth.py

@@ -161,6 +161,11 @@ def from_dict(
     ) -> Auth:
         pass
 
+    @property
+    @abc.abstractmethod
+    def value(self):
+        pass
+
     def write(
         self,
         filename: str = None
@@ -254,8 +259,8 @@ def __init__(
         '''
         if not key:
             raise APIKeyAuthException('API key cannot be empty.')
-        self.key = key
-        super().__init__(self.key, '')
+        self._key = key
+        super().__init__(self._key, '')
 
     @classmethod
     def from_dict(
@@ -268,7 +273,11 @@ def from_dict(
 
     def to_dict(self):
         '''Represent APIKeyAuth as a dict.'''
-        return {self.DICT_KEY: self.key}
+        return {self.DICT_KEY: self._key}
+
+    @property
+    def value(self):
+        return self._key
 
 
 class _SecretFile():

tests/unit/test_auth.py

@@ -27,14 +27,14 @@
 
 def test_Auth_read_key():
     test_auth = auth.Auth.read(key='test')
-    assert test_auth.key == 'test'
+    assert test_auth.value == 'test'
 
 
 def test_Auth_read_env(monkeypatch):
     monkeypatch.setenv('PL_API_KEY', 'a')
 
     test_auth_env1 = auth.Auth.read()
-    assert test_auth_env1.key == 'a'
+    assert test_auth_env1.value == 'a'
 
 
 def test_Auth_read_file(tmp_path, monkeypatch):
@@ -45,7 +45,7 @@ def test_Auth_read_file(tmp_path, monkeypatch):
     monkeypatch.delenv('PL_API_KEY', raising=False)
     monkeypatch.setattr(auth, 'SECRET_FILE_PATH', secret_path)
     test_auth = auth.Auth.read()
-    assert test_auth.key == 'testvar'
+    assert test_auth.value == 'testvar'
 
 
 def test_Auth_read_error(tmp_path, monkeypatch):
@@ -68,7 +68,7 @@ def test_Auth_from_file_alternate_success(tmp_path):
         fp.write('{"key": "testvar"}')
 
     test_auth = auth.Auth.from_file(secret_path)
-    assert test_auth.key == 'testvar'
+    assert test_auth.value == 'testvar'
 
 
 def test_Auth_from_file_alternate_doesnotexist(tmp_path):
@@ -92,7 +92,7 @@ def test_Auth_from_env_alternate_success(monkeypatch):
     monkeypatch.delenv('PL_API_KEY', raising=False)
 
     test_auth_env1 = auth.Auth.from_env(alternate)
-    assert test_auth_env1.key == 'testkey'
+    assert test_auth_env1.value == 'testkey'
 
 
 def test_Auth_from_env_alternate_doesnotexist(monkeypatch):
@@ -121,7 +121,7 @@ def test_Auth_from_login(monkeypatch):
 
     monkeypatch.setattr(auth, 'AUTH_URL', test_url)
     test_auth = auth.Auth.from_login('email', 'pw')
-    assert test_auth.key == 'foobar'
+    assert test_auth.value == 'foobar'
 
 
 def test_Auth_write_doesnotexist(tmp_path):