pulse-python-sdk 0.0.58__tar.gz → 0.0.59__tar.gz

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pulse-python-sdk
-Version: 0.0.58
+Version: 0.0.59
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -63,7 +63,9 @@ Instantiate and use the client with the following:
 ```python
 from pulse import Pulse
 
-client = Pulse()
+client = Pulse(
+    api_key="YOUR_API_KEY",
+)
 client.extract()
 ```
 
@@ -76,7 +78,9 @@ import asyncio
 
 from pulse import AsyncPulse
 
-client = AsyncPulse()
+client = AsyncPulse(
+    api_key="YOUR_API_KEY",
+)
 
 
 async def main() -> None:

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/README.md

@@ -36,7 +36,9 @@ Instantiate and use the client with the following:
 ```python
 from pulse import Pulse
 
-client = Pulse()
+client = Pulse(
+    api_key="YOUR_API_KEY",
+)
 client.extract()
 ```
 
@@ -49,7 +51,9 @@ import asyncio
 
 from pulse import AsyncPulse
 
-client = AsyncPulse()
+client = AsyncPulse(
+    api_key="YOUR_API_KEY",
+)
 
 
 async def main() -> None:

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "pulse-python-sdk"
-version = "0.0.58"
+version = "0.0.59"
 description = ""
 readme = "README.md"
 authors = []

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/src/pulse/client.py

@@ -2,10 +2,12 @@
 
 from __future__ import annotations
 
+import os
 import typing
 
 import httpx
 from . import core
+from .core.api_error import ApiError
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .core.request_options import RequestOptions
 from .environment import PulseEnvironment
@@ -46,6 +48,7 @@ class Pulse:
 
 
 
+    api_key : typing.Optional[str]
     headers : typing.Optional[typing.Dict[str, str]]
         Additional headers to send with every request.
 
@@ -62,7 +65,9 @@ class Pulse:
     --------
     from pulse import Pulse
 
-    client = Pulse()
+    client = Pulse(
+        api_key="YOUR_API_KEY",
+    )
     """
 
     def __init__(
@@ -70,6 +75,7 @@ class Pulse:
         *,
         base_url: typing.Optional[str] = None,
         environment: PulseEnvironment = PulseEnvironment.DEFAULT,
+        api_key: typing.Optional[str] = os.getenv("PULSE_API_KEY"),
         headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
@@ -78,8 +84,11 @@ class Pulse:
         _defaulted_timeout = (
             timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
         )
+        if api_key is None:
+            raise ApiError(body="The client must be instantiated be either passing in api_key or setting PULSE_API_KEY")
         self._client_wrapper = SyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
+            api_key=api_key,
             headers=headers,
             httpx_client=httpx_client
             if httpx_client is not None
@@ -187,7 +196,9 @@ class Pulse:
         --------
         from pulse import Pulse
 
-        client = Pulse()
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
         client.extract()
         """
         _response = self._raw_client.extract(
@@ -294,7 +305,9 @@ class Pulse:
         --------
         from pulse import Pulse
 
-        client = Pulse()
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
         client.extract_async()
         """
         _response = self._raw_client.extract_async(
@@ -352,6 +365,7 @@ class AsyncPulse:
 
 
 
+    api_key : typing.Optional[str]
     headers : typing.Optional[typing.Dict[str, str]]
         Additional headers to send with every request.
 
@@ -368,7 +382,9 @@ class AsyncPulse:
     --------
     from pulse import AsyncPulse
 
-    client = AsyncPulse()
+    client = AsyncPulse(
+        api_key="YOUR_API_KEY",
+    )
     """
 
     def __init__(
@@ -376,6 +392,7 @@ class AsyncPulse:
         *,
         base_url: typing.Optional[str] = None,
         environment: PulseEnvironment = PulseEnvironment.DEFAULT,
+        api_key: typing.Optional[str] = os.getenv("PULSE_API_KEY"),
         headers: typing.Optional[typing.Dict[str, str]] = None,
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
@@ -384,8 +401,11 @@ class AsyncPulse:
         _defaulted_timeout = (
             timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
         )
+        if api_key is None:
+            raise ApiError(body="The client must be instantiated be either passing in api_key or setting PULSE_API_KEY")
         self._client_wrapper = AsyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
+            api_key=api_key,
             headers=headers,
             httpx_client=httpx_client
             if httpx_client is not None
@@ -495,7 +515,9 @@ class AsyncPulse:
 
         from pulse import AsyncPulse
 
-        client = AsyncPulse()
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
 
 
         async def main() -> None:
@@ -610,7 +632,9 @@ class AsyncPulse:
 
         from pulse import AsyncPulse
 
-        client = AsyncPulse()
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
 
 
         async def main() -> None:

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/src/pulse/core/client_wrapper.py

@@ -10,22 +10,25 @@ class BaseClientWrapper:
     def __init__(
         self,
         *,
+        api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
     ):
+        self.api_key = api_key
         self._headers = headers
         self._base_url = base_url
         self._timeout = timeout
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "pulse-python-sdk/0.0.58",
+            "User-Agent": "pulse-python-sdk/0.0.59",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "pulse-python-sdk",
-            "X-Fern-SDK-Version": "0.0.58",
+            "X-Fern-SDK-Version": "0.0.59",
             **(self.get_custom_headers() or {}),
         }
+        headers["x-api-key"] = self.api_key
         return headers
 
     def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]:
@@ -42,12 +45,13 @@ class SyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
+        api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.Client,
     ):
-        super().__init__(headers=headers, base_url=base_url, timeout=timeout)
+        super().__init__(api_key=api_key, headers=headers, base_url=base_url, timeout=timeout)
         self.httpx_client = HttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,
@@ -60,13 +64,14 @@ class AsyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
+        api_key: str,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         async_token: typing.Optional[typing.Callable[[], typing.Awaitable[str]]] = None,
         httpx_client: httpx.AsyncClient,
     ):
-        super().__init__(headers=headers, base_url=base_url, timeout=timeout)
+        super().__init__(api_key=api_key, headers=headers, base_url=base_url, timeout=timeout)
         self._async_token = async_token
         self.httpx_client = AsyncHttpClient(
             httpx_client=httpx_client,

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/src/pulse/jobs/client.py

@@ -46,7 +46,9 @@ class JobsClient:
         --------
         from pulse import Pulse
 
-        client = Pulse()
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
         client.jobs.get_job(
             job_id="jobId",
         )
@@ -78,7 +80,9 @@ class JobsClient:
         --------
         from pulse import Pulse
 
-        client = Pulse()
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
         client.jobs.cancel_job(
             job_id="jobId",
         )
@@ -128,7 +132,9 @@ class AsyncJobsClient:
 
         from pulse import AsyncPulse
 
-        client = AsyncPulse()
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
 
 
         async def main() -> None:
@@ -168,7 +174,9 @@ class AsyncJobsClient:
 
         from pulse import AsyncPulse
 
-        client = AsyncPulse()
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
 
 
         async def main() -> None:

{pulse_python_sdk-0.0.58 → pulse_python_sdk-0.0.59}/src/pulse/webhooks/client.py

@@ -43,7 +43,9 @@ class WebhooksClient:
         --------
         from pulse import Pulse
 
-        client = Pulse()
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
         client.webhooks.create_webhook_link()
         """
         _response = self._raw_client.create_webhook_link(request_options=request_options)
@@ -87,7 +89,9 @@ class AsyncWebhooksClient:
 
         from pulse import AsyncPulse
 
-        client = AsyncPulse()
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
 
 
         async def main() -> None: