athena-intelligence 0.1.88__tar.gz → 0.1.89__tar.gz

{athena_intelligence-0.1.88 → athena_intelligence-0.1.89}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: athena-intelligence
-Version: 0.1.88
+Version: 0.1.89
 Summary: Athena Intelligence Python Library
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers

{athena_intelligence-0.1.88 → athena_intelligence-0.1.89}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "athena-intelligence"
-version = "0.1.88"
+version = "0.1.89"
 description = "Athena Intelligence Python Library"
 readme = "README.md"
 authors = []

{athena_intelligence-0.1.88 → athena_intelligence-0.1.89}/src/athena/client.py

@@ -21,42 +21,103 @@ T = TypeVar("T")
 U = TypeVar('U')
 
 
-def _inherit_signature(f: typing.Callable[P, T]) -> typing.Callable[..., typing.Callable[P, U]]:
-    return lambda x: x
+def _inherit_signature_and_doc(
+    f: typing.Callable[P, T],
+    replace_in_doc: typing.Dict[str, str]
+) -> typing.Callable[..., typing.Callable[P, U]]:
+    def decorator(decorated):
+        for old, new in replace_in_doc.items():
+            assert old in f.__doc__
+            decorated.__doc__ = f.__doc__.replace(old, new)
+        return decorated
+    return decorator
 
 
 class WrappedToolsClient(ToolsClient):
 
     def get_file(self, document_id: str) -> io.BytesIO:
+        """
+        Parameters
+        ----------
+        document_id : str
+
+        Returns
+        -------
+        io.BytesIO
+
+        Examples
+        --------
+        import polars as pl
+        from athena.client import Athena
+
+        client = Athena(api_key="YOUR_API_KEY")
+        file_io = client.tools.get_file(document_id="document_id")
+        pl.read_csv(file_io)
+        """
         file_bytes = b''.join(self.raw_data(document_id=document_id))
         bytes_io = io.BytesIO(file_bytes)
         return bytes_io
 
-    @_inherit_signature(ToolsClient.data_frame)
+    @_inherit_signature_and_doc(ToolsClient.data_frame, {'DataFrameRequestOut': 'pd.DataFrame'})
     def data_frame(self, *, document_id: str, **kwargs) -> 'pd.DataFrame':
         _check_pandas_installed()
         model = super().data_frame(document_id=document_id, **kwargs)
         return _read_json_frame(model)
 
     def read_data_frame(self, document_id: str, *args, **kwargs) -> 'pd.DataFrame':
+        """
+        Parameters
+        ----------
+        document_id : str
+
+        **kwargs : dict
+          keyword arguments passed to pandas `read_csv` or `read_excel` function,
+          depending on the file type of the document identified by `document_id`.
+
+        Returns
+        -------
+        pd.DataFrame
+
+        Examples
+        --------
+        from athena.client import Athena
+
+        client = Athena(api_key="YOUR_API_KEY")
+        client.tools.read_data_frame(document_id="document_id")
+        """
         _check_pandas_installed()
         file_bytes = self.get_file(document_id)
         return _to_pandas_df(file_bytes, *args, **kwargs)
 
 
+def _add_docs_for_async_variant(obj):
+    def decorator(decorated):
+        doc = obj.__doc__
+        name = obj.__name__
+        decorated.__doc__ = (
+            doc
+            .replace('client = Athena', 'client = AsyncAthena')
+            .replace(f'client.tools.{name}', f'await client.tools.{name}')
+        )
+        return decorated
+    return decorator
+
+
 class WrappedAsyncToolsClient(AsyncToolsClient):
 
+    @_add_docs_for_async_variant(WrappedToolsClient.get_file)
     async def get_file(self, document_id: str) -> io.BytesIO:
         file_bytes = b''.join([gen async for gen in self.raw_data(document_id=document_id)])
         bytes_io = io.BytesIO(file_bytes)
         return bytes_io
 
-    @_inherit_signature(ToolsClient.data_frame)
+    @_inherit_signature_and_doc(AsyncToolsClient.data_frame, {'DataFrameRequestOut': 'pd.DataFrame'})
     async def data_frame(self, *, document_id: str, **kwargs) -> 'pd.DataFrame':
         _check_pandas_installed()
         model = await super().data_frame(document_id=document_id, **kwargs)
         return _read_json_frame(model)
 
+    @_add_docs_for_async_variant(WrappedToolsClient.read_data_frame)
     async def read_data_frame(self, document_id: str, *args, **kwargs) -> 'pd.DataFrame':
         _check_pandas_installed()
         file_bytes = await self.get_file(document_id)
@@ -83,7 +144,7 @@ class Athena(BaseAthena):
 
     api_key: typing.Optional[str].  The API key. Required when used outside of the athena notebook environment.
     timeout : typing.Optional[float]
-        The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
 
     httpx_client : typing.Optional[httpx.Client]
         The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
@@ -97,6 +158,8 @@ class Athena(BaseAthena):
     )
     """
 
+    tools: WrappedToolsClient
+
     def __init__(
         self,
         *,
@@ -147,7 +210,7 @@ class AsyncAthena(AsyncBaseAthena):
 
     api_key: typing.Optional[str].  The API key. Required when used outside of the athena notebook environment.
     timeout : typing.Optional[float]
-        The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+        The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
 
     httpx_client : typing.Optional[httpx.AsyncClient]
         The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
@@ -161,6 +224,8 @@ class AsyncAthena(AsyncBaseAthena):
     )
     """
 
+    tools: WrappedAsyncToolsClient
+
     def __init__(
         self,
         *,

{athena_intelligence-0.1.88 → athena_intelligence-0.1.89}/src/athena/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "athena-intelligence",
-            "X-Fern-SDK-Version": "0.1.88",
+            "X-Fern-SDK-Version": "0.1.89",
         }
         headers["X-API-KEY"] = self.api_key
         return headers