feat(api): OpenAPI spec update via Stainless API (#20)

Author: stainless-app[bot]

README.md

@@ -25,10 +25,12 @@ pip install git+ssh://git@github.com/lumalabs/lumaai-python.git
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from lumaai import Lumaai
 
 client = Lumaai(
-    auth_token="My Auth Token",
+    # This is the default and can be omitted
+    auth_token=os.environ.get("LUMAAI_API_KEY"),
 )
 
 generation = client.generations.create(
@@ -39,16 +41,23 @@ generation = client.generations.create(
 print(generation.id)
 ```
 
+While you can provide a `auth_token` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `LUMAAI_API_KEY="My Auth Token"` to your `.env` file
+so that your Auth Token is not stored in source control.
+
 ## Async usage
 
 Simply import `AsyncLumaai` instead of `Lumaai` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from lumaai import AsyncLumaai
 
 client = AsyncLumaai(
-    auth_token="My Auth Token",
+    # This is the default and can be omitted
+    auth_token=os.environ.get("LUMAAI_API_KEY"),
 )
 
 

src/lumaai/_client.py

@@ -25,7 +25,7 @@
 )
 from ._version import __version__
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
-from ._exceptions import APIStatusError
+from ._exceptions import LumaaiError, APIStatusError
 from ._base_client import (
     DEFAULT_MAX_RETRIES,
     SyncAPIClient,
@@ -57,7 +57,7 @@ class Lumaai(SyncAPIClient):
     def __init__(
         self,
         *,
-        auth_token: str,
+        auth_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -77,7 +77,16 @@ def __init__(
         # part of our public interface in the future.
         _strict_response_validation: bool = False,
     ) -> None:
-        """Construct a new synchronous lumaai client instance."""
+        """Construct a new synchronous lumaai client instance.
+
+        This automatically infers the `auth_token` argument from the `LUMAAI_API_KEY` environment variable if it is not provided.
+        """
+        if auth_token is None:
+            auth_token = os.environ.get("LUMAAI_API_KEY")
+        if auth_token is None:
+            raise LumaaiError(
+                "The auth_token client option must be set either by passing auth_token to the client or by setting the LUMAAI_API_KEY environment variable"
+            )
         self.auth_token = auth_token
 
         if base_url is None:
@@ -218,7 +227,7 @@ class AsyncLumaai(AsyncAPIClient):
     def __init__(
         self,
         *,
-        auth_token: str,
+        auth_token: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -238,7 +247,16 @@ def __init__(
         # part of our public interface in the future.
         _strict_response_validation: bool = False,
     ) -> None:
-        """Construct a new async lumaai client instance."""
+        """Construct a new async lumaai client instance.
+
+        This automatically infers the `auth_token` argument from the `LUMAAI_API_KEY` environment variable if it is not provided.
+        """
+        if auth_token is None:
+            auth_token = os.environ.get("LUMAAI_API_KEY")
+        if auth_token is None:
+            raise LumaaiError(
+                "The auth_token client option must be set either by passing auth_token to the client or by setting the LUMAAI_API_KEY environment variable"
+            )
         self.auth_token = auth_token
 
         if base_url is None:

tests/test_client.py

@@ -17,9 +17,10 @@
 from pydantic import ValidationError
 
 from lumaai import Lumaai, AsyncLumaai, APIResponseValidationError
+from lumaai._types import Omit
 from lumaai._models import BaseModel, FinalRequestOptions
 from lumaai._constants import RAW_RESPONSE_HEADER
-from lumaai._exceptions import APIStatusError, APITimeoutError, APIResponseValidationError
+from lumaai._exceptions import LumaaiError, APIStatusError, APITimeoutError, APIResponseValidationError
 from lumaai._base_client import DEFAULT_TIMEOUT, HTTPX_DEFAULT_TIMEOUT, BaseClient, make_request_options
 
 from .utils import update_env
@@ -328,6 +329,11 @@ def test_validate_headers(self) -> None:
         request = client._build_request(FinalRequestOptions(method="get", url="/foo"))
         assert request.headers.get("Authorization") == f"Bearer {auth_token}"
 
+        with pytest.raises(LumaaiError):
+            with update_env(**{"LUMAAI_API_KEY": Omit()}):
+                client2 = Lumaai(base_url=base_url, auth_token=None, _strict_response_validation=True)
+            _ = client2
+
     def test_default_query_option(self) -> None:
         client = Lumaai(
             base_url=base_url,
@@ -1055,6 +1061,11 @@ def test_validate_headers(self) -> None:
         request = client._build_request(FinalRequestOptions(method="get", url="/foo"))
         assert request.headers.get("Authorization") == f"Bearer {auth_token}"
 
+        with pytest.raises(LumaaiError):
+            with update_env(**{"LUMAAI_API_KEY": Omit()}):
+                client2 = AsyncLumaai(base_url=base_url, auth_token=None, _strict_response_validation=True)
+            _ = client2
+
     def test_default_query_option(self) -> None:
         client = AsyncLumaai(
             base_url=base_url,