Remove dotenv load (#151)

* remove autoload of env variable

* update docstrings

* remove dependency

* format

* dependencies

Author: vvillait88

README.md

@@ -28,6 +28,7 @@
 - [📘 Documentation](#documentation)
   - [Upgrading to v2.X.X](#upgrading-to-v2)
   - [Upgrading to v3.X.X](#upgrading-to-v3)
+  - [Upgrading to v4.X.X](#upgrading-to-v4)
 
 
 ## 🔧 Installation <a name="installation"></a>
@@ -39,7 +40,6 @@
     ```
 
 2. Sign up for a [free PDL API key](https://www.peopledatalabs.com/signup).
-3. Set your API key in the `PDL_API_KEY` environment variable.
 
 ## 🚀 Usage <a name="usage"></a>
 
@@ -49,17 +49,13 @@ First, create the PDLPY client:
 from peopledatalabs import PDLPY
 
 
-# specifying an API key
+# specify your API key
 client = PDLPY(
     api_key="YOUR API KEY",
 )
 
-# or leave blank if you have PDL_API_KEY set in your environment or .env file
-client = PDLPY()
 ```
 
-**Note:** You can provide your API key directly in code, or alternatively set a `PDL_API_KEY` variable in your environment or `.env` file.
-
 Then, send requests to any PDL API Endpoint.
 
 ### Getting Person Data
@@ -499,3 +495,7 @@ NOTE: When upgrading to v2.X.X from vX.X.X and below, the minimum required pytho
 ### Upgrading to v3.X.X <a name="upgrading-to-v3"></a>
 
 NOTE: When upgrading to v3.X.X from vX.X.X and below, the minimum required pydantic version is now 2.
+
+### Upgrading to v4.X.X <a name="upgrading-to-v4"></a>
+
+NOTE: When upgrading to v4.X.X from vX.X.X and below, we no longer auto load the API key from the environment variable `PDL_API_KEY`. You must now pass the API key as a parameter to the `PDLPY` class.

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "peopledatalabs"
-version = "3.1.4"
+version = "4.0.0"
 description = "Official Python client for the People Data Labs API"
 homepage = "https://www.peopledatalabs.com"
 repository = "https://github.com/peopledatalabs/peopledatalabs-python"
@@ -31,7 +31,6 @@ classifiers = [
 python = "^3.8"
 email-validator = ">=1.1,<3.0"
 pydantic = "^2"
-python-dotenv = "<2"
 requests = "^2"
 
 [tool.poetry.dev-dependencies]
@@ -41,7 +40,7 @@ coverage = "^7.5.3"
 docformatter = "^1.7"
 flake8 = "^5.0.4"
 pylint = "^3.2.6"
-pytest = "^8.3.1"
+pytest = "^8.3.2"
 pyupgrade = "^3.3.2"
 
 [build-system]

pyproject.toml

@@ -197,9 +197,6 @@ pydantic-core==2.20.1 ; python_version >= "3.8" and python_version < "4.0" \
 pydantic==2.8.2 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:6f62c13d067b0755ad1c21a34bdd06c0c12625a22b0fc09c6b149816604f7c2a \
     --hash=sha256:73ee9fddd406dc318b885c7a2eab8a6472b68b8fb5ba8150949fc3db939f23c8
-python-dotenv==1.0.1 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:e324ee90a023d808f1959c46bcbc04446a10ced277783dc6ee09987c37ec10ca \
-    --hash=sha256:f7b63ef50f1b690dddf550d03497b66d609393b40b564ed0d674909a68ebf16a
 requests==2.32.3 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760 \
     --hash=sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6

requirements.txt

@@ -330,12 +330,9 @@ pyflakes==2.5.0 ; python_version >= "3.8" and python_version < "4.0" \
 pylint==3.2.6 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:03c8e3baa1d9fb995b12c1dbe00aa6c4bcef210c2a2634374aedeb22fb4a8f8f \
     --hash=sha256:a5d01678349454806cff6d886fb072294f56a58c4761278c97fb557d708e1eb3
-pytest==8.3.1 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:7e8e5c5abd6e93cb1cc151f23e57adc31fcf8cfd2a3ff2da63e23f732de35db6 \
-    --hash=sha256:e9600ccf4f563976e2c99fa02c7624ab938296551f280835ee6516df8bc4ae8c
-python-dotenv==1.0.1 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:e324ee90a023d808f1959c46bcbc04446a10ced277783dc6ee09987c37ec10ca \
-    --hash=sha256:f7b63ef50f1b690dddf550d03497b66d609393b40b564ed0d674909a68ebf16a
+pytest==8.3.2 ; python_version >= "3.8" and python_version < "4.0" \
+    --hash=sha256:4ba08f9ae7dcf84ded419494d229b48d0903ea6407b030eaec46df5e6a73bba5 \
+    --hash=sha256:c132345d12ce551242c87269de812483f5bcc87cdbb4722e48487ba194f9fdce
 pyupgrade==3.8.0 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:08d0e6129f5e9da7e7a581bdbea689e0d49c3c93eeaf156a07ae2fd794f52660 \
     --hash=sha256:1facb0b8407cca468dfcc1d13717e3a85aa37b9e6e7338664ad5bfe5ef50c867

requirements_dev.txt

@@ -5,6 +5,6 @@
 from .main import PDLPY
 
 
-__version__ = "3.1.4"
+__version__ = "4.0.0"
 
 __all__ = ["PDLPY"]

src/peopledatalabs/__init__.py

@@ -52,10 +52,7 @@ def api_key_not_none(cls, v):
         Checks an API key is passed to the Client object.
         """
         if v is None:
-            raise ValueError(
-                "Please enter a value for API key, or define it either in"
-                " your environment or .env file as PDL_API_KEY"
-            )
+            raise ValueError("Please enter a value for API key.")
         return v
 
     def __post_init__(self):

src/peopledatalabs/main.py

@@ -51,7 +51,7 @@ def get(self):
         """
         Executes a GET request from the specified API.
 
-        User's PDL_API_KEY is sent in request parameters.
+        User's api_key is sent in request parameters.
 
         Returns:
             A requests.Response object with the result of the HTTP call.
@@ -70,7 +70,7 @@ def post(self):
         """
         Executes a POST request to the specified API.
 
-        User's PDL_API_KEY is sent as a 'X-api-key' header.
+        User's api_key is sent as a 'X-api-key' header.
 
         Returns:
             A requests.Response object with the result of the HTTP call.

src/peopledatalabs/requests.py

@@ -1,13 +1,7 @@
 """
 A settings singleton to share settings across different modules of the package.
-
-Settings also loads environment variables eventually declared in an .env
-file.
 """
 
-import os
-
-from dotenv import find_dotenv, load_dotenv
 from pydantic.v1 import HttpUrl
 from pydantic.v1.dataclasses import dataclass
 
@@ -16,11 +10,6 @@
 class Settings:
     """
     Singleton holding app's settings.
-
-    Settings are eventually overridden if a .env file is provided, or
-    environment variables are defined.
-
-    All env variables should be in the form of PDL_<setting name>
     """
 
     api_key: str = None
@@ -31,11 +20,5 @@ class Settings:
     version_re: str = r"^v[0-9]$"
     sandbox_base_path: HttpUrl = "https://sandbox.api.peopledatalabs.com/"
 
-    def __post_init__(self):
-        load_dotenv(dotenv_path=find_dotenv(usecwd=True))
-        for key in self.__dict__:
-            env_key = "PDL_" + key.upper()
-            self.__dict__[key] = os.getenv(env_key, self.__dict__[key])
-
 
 settings = Settings()

src/peopledatalabs/settings.py

@@ -19,7 +19,7 @@ def test_version():
     """
     Version check.
     """
-    assert __version__ == "3.1.4"
+    assert __version__ == "4.0.0"
 
 
 @pytest.mark.usefixtures("fake_api_key")
@@ -59,11 +59,8 @@ def test_init_defaults_version_only(fake_api_key):
 
 def test_init_no_api_key_raises_validation_error():
     """
-    Tests that instantiating the client without providing either an .env file
-    or an api key explicitly, a ValidationError is raised.
-
-    To make this test pass either ".env" file should not exist or
-    env_file modified in get_settings()
+    Tests that instantiating the client without providing an api key
+    explicitly, a ValidationError is raised.
     """
     with pytest.raises(ValidationError):
         PDLPY()

tests/client/test_client.py

@@ -26,9 +26,9 @@ def fixture_fake_api_key():
 @pytest.fixture
 def client():
     """
-    Client instance loads PDL_API_KEY from .env file.
+    Client instance loads with real API key.
     """
-    return PDLPY()
+    return PDLPY(api_key=os.environ["PDL_API_KEY"])
 
 
 @pytest.fixture
@@ -42,9 +42,9 @@ def client_with_fake_api_key(fake_api_key):
 @pytest.fixture
 def client_sandbox_enabled():
     """
-    Client instance loads PDL_API_KEY from .env file and Sandbox enabled.
+    Client instance loads with real API key and Sandbox enabled.
     """
-    return PDLPY(sandbox=True)
+    return PDLPY(sandbox=True, api_key=os.environ["PDL_API_KEY"])
 
 
 @pytest.fixture