Add Client.from_env constructor (#62)

Author: bh2smith

README.md

@@ -17,9 +17,6 @@ Export your `DUNE_API_KEY` (or place it in a `.env` file - as in
 here [.env.sample](./.env.sample).
 
 ```python
-import dotenv
-import os
-
 from dune_client.types import QueryParameter
 from dune_client.client import DuneClient
 from dune_client.query import QueryBase
@@ -36,8 +33,7 @@ query = QueryBase(
 )
 print("Results available at", query.url())
 
-dotenv.load_dotenv()
-dune = DuneClient(os.environ["DUNE_API_KEY"])
+dune = DuneClient.from_env()
 results = dune.refresh(query)
 ```
 

dune_client/base_client.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 import logging.config
+import os
 from typing import Dict
 
 
@@ -27,6 +28,15 @@ def __init__(
         self.logger = logging.getLogger(__name__)
         logging.basicConfig(format="%(asctime)s %(levelname)s %(name)s %(message)s")
 
+    @classmethod
+    def from_env(cls) -> BaseDuneClient:
+        """
+        Constructor allowing user to instantiate a client from environment variable
+        without having to import dotenv or os manually
+        We use `DUNE_API_KEY` as the environment variable that holds the API key.
+        """
+        return cls(os.environ["DUNE_API_KEY"])
+
     @property
     def api_version(self) -> str:
         """Returns client version string"""

requirements/prod.txt

@@ -4,4 +4,4 @@ types-PyYAML>=6.0.12.11
 types-requests>=2.31.0.2
 python-dateutil>=2.8.2
 requests>=2.31.0
-ndjson>=0.3.1
+ndjson>=0.3.1

tests/e2e/test_client.py

@@ -14,6 +14,8 @@
 )
 from dune_client.query import QueryBase
 
+dotenv.load_dotenv()
+
 
 class TestDuneClient(unittest.TestCase):
     def setUp(self) -> None:
@@ -28,9 +30,14 @@ def setUp(self) -> None:
                 QueryParameter.enum_type(name="ListField", value="Option 1"),
             ],
         )
-        dotenv.load_dotenv()
         self.valid_api_key = os.environ["DUNE_API_KEY"]
 
+    def test_from_env_constructor(self):
+        try:
+            DuneClient.from_env()
+        except KeyError:
+            self.fail("DuneClient.from_env raised unexpectedly!")
+
     def test_get_status(self):
         query = QueryBase(name="No Name", query_id=1276442, params=[])
         dune = DuneClient(self.valid_api_key)
@@ -189,7 +196,6 @@ def test_upload_csv_success(self):
 @unittest.skip("This is an enterprise only endpoint that can no longer be tested.")
 class TestCRUDOps(unittest.TestCase):
     def setUp(self) -> None:
-        dotenv.load_dotenv()
         self.valid_api_key = os.environ["DUNE_API_KEY"]
         self.client = DuneClient(self.valid_api_key, client_version="alpha/v1")
         self.existing_query_id = 2713571