athena-intelligence 0.1.13__tar.gz → 0.1.15__tar.gz

athena_intelligence-0.1.15/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.1
+Name: athena-intelligence
+Version: 0.1.15
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Athena Intelligence Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![pypi](https://img.shields.io/pypi/v/athena-intelligence.svg)](https://pypi.python.org/pypi/athena-intelligence)
+
+The Athena Intelligence Python Library provides convenient access to the Athena Intelligence API from 
+applications written in Python. 
+
+The library includes type definitions for all 
+request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Installation
+
+Add this dependency to your project's build file:
+
+```bash
+pip install athena-intelligence
+# or
+poetry add athena-intelligence
+```
+
+## Usage
+Simply import `Athena` and start making calls to our API. 
+
+```python
+from athena.client import Athena
+
+client = Athena(
+  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
+)
+message = client.messages.get("message_id")
+```
+
+## Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from athena.client import AsyncAthena
+
+client = AsyncAthena(
+  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
+)
+
+async def main() -> None:
+    message = client.messages.get("message_id")
+    print("Received message", message)
+
+asyncio.run(main())
+```
+
+## Athena Module
+All of the models are nested within the Athena module. Let IntelliSense 
+guide you! 
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/athena/core/api_error.py).
+
+```python
+import athena
+
+try:
+  client.messages.get(...)
+except athena.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from athena.client import Athena
+
+client = Athena(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.messages.get(..., {
+    timeout_in_seconds=20
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from athena.client import Athena
+
+client = Athena(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in **Preview**, and there may be breaking changes between versions without a major 
+version update. 
+
+To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

athena_intelligence-0.1.15/README.md

@@ -0,0 +1,121 @@
+# Athena Intelligence Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![pypi](https://img.shields.io/pypi/v/athena-intelligence.svg)](https://pypi.python.org/pypi/athena-intelligence)
+
+The Athena Intelligence Python Library provides convenient access to the Athena Intelligence API from 
+applications written in Python. 
+
+The library includes type definitions for all 
+request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Installation
+
+Add this dependency to your project's build file:
+
+```bash
+pip install athena-intelligence
+# or
+poetry add athena-intelligence
+```
+
+## Usage
+Simply import `Athena` and start making calls to our API. 
+
+```python
+from athena.client import Athena
+
+client = Athena(
+  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
+)
+message = client.messages.get("message_id")
+```
+
+## Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from athena.client import AsyncAthena
+
+client = AsyncAthena(
+  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
+)
+
+async def main() -> None:
+    message = client.messages.get("message_id")
+    print("Received message", message)
+
+asyncio.run(main())
+```
+
+## Athena Module
+All of the models are nested within the Athena module. Let IntelliSense 
+guide you! 
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/athena/core/api_error.py).
+
+```python
+import athena
+
+try:
+  client.messages.get(...)
+except athena.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from athena.client import Athena
+
+client = Athena(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.messages.get(..., {
+    timeout_in_seconds=20
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from athena.client import Athena
+
+client = Athena(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in **Preview**, and there may be breaking changes between versions without a major 
+version update. 
+
+To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

{athena_intelligence-0.1.13 → athena_intelligence-0.1.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "athena-intelligence"
-version = "0.1.13"
+version = "0.1.15"
 description = ""
 readme = "README.md"
 authors = []

{athena_intelligence-0.1.13 → athena_intelligence-0.1.15}/src/athena/client.py

@@ -6,7 +6,8 @@ import httpx
 
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .environment import AthenaEnvironment
-from .message.client import AsyncMessageClient, MessageClient
+from .polling_message_client import \
+        MessagePollingClient, AsyncMessagePollingClient
 
 
 class Athena:
@@ -47,7 +48,7 @@ class Athena:
             api_key=api_key,
             httpx_client=httpx.Client(timeout=timeout) if httpx_client is None else httpx_client,
         )
-        self.message = MessageClient(client_wrapper=self._client_wrapper)
+        self.message = MessagePollingClient(client_wrapper=self._client_wrapper)
 
 
 class AsyncAthena:
@@ -88,7 +89,7 @@ class AsyncAthena:
             api_key=api_key,
             httpx_client=httpx.AsyncClient(timeout=timeout) if httpx_client is None else httpx_client,
         )
-        self.message = AsyncMessageClient(client_wrapper=self._client_wrapper)
+        self.message = AsyncMessagePollingClient(client_wrapper=self._client_wrapper)
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: AthenaEnvironment) -> str:
@@ -97,4 +98,4 @@ def _get_base_url(*, base_url: typing.Optional[str] = None, environment: AthenaE
     elif environment is not None:
         return environment.value
     else:
-        raise Exception("Please pass in either base_url or environment to construct the client")
+        raise Exception("Please pass in either base_url or environment to construct the client")

{athena_intelligence-0.1.13 → athena_intelligence-0.1.15}/src/athena/core/client_wrapper.py

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

athena_intelligence-0.1.15/src/athena/polling_message_client.py

@@ -0,0 +1,128 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import time
+import typing
+
+from athena.types.message_out_dto import MessageOutDto
+
+from .core import RequestOptions
+from .message.client import AsyncMessageClient, MessageClient
+from .types.model import Model
+from .types.tools import Tools
+from .types.status_enum import StatusEnum
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class MessagePollingClient(MessageClient):
+
+    def submit(  # type: ignore
+        self,
+        *,
+        content: str,
+        model: typing.Optional[Model] = OMIT,
+        tools: typing.Optional[typing.Sequence[Tools]] = OMIT,
+        conversation_id: typing.Optional[str] = OMIT,
+        conversation_name: typing.Optional[str] = OMIT,
+        poll_interval: int = 2,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> MessageOutDto:
+        """
+        Parameters:
+            - content: str.
+
+            - model: typing.Optional[Model].
+
+            - tools: typing.Optional[typing.Sequence[Tools]].
+
+            - conversation_id: typing.Optional[str].
+
+            - conversation_name: typing.Optional[str].
+
+            - poll_interval: int. The polling interval in seconds.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from athena import Model, Tools
+        from athena.client import Athena
+
+        client = Athena(
+            api_key="YOUR_API_KEY",
+            token="YOUR_TOKEN",
+        )
+        client.message.submit(
+            content="visit www.athenaintelligence.ai and summarize the website in one paragraph",
+            model=Model.GPT_4_TURBO_PREVIEW,
+            tools=[Tools.SEARCH, Tools.BROWSE],
+        )
+        """
+        response = super().submit(
+          content=content,
+          model=model,
+          tools=tools,
+          conversation_id=conversation_id, 
+          conversation_name=conversation_name,
+          request_options=request_options)
+        message = self.get(id=response.id)
+        while message.status != StatusEnum.RESPONDED \
+                or message.status != StatusEnum.ERROR:
+            time.sleep(poll_interval)
+            message = self.get(id=message.id)
+        return message
+
+
+class AsyncMessagePollingClient(AsyncMessageClient):
+
+    async def submit(  # type: ignore
+        self,
+        *,
+        content: str,
+        model: typing.Optional[Model] = OMIT,
+        tools: typing.Optional[typing.Sequence[Tools]] = OMIT,
+        conversation_id: typing.Optional[str] = OMIT,
+        conversation_name: typing.Optional[str] = OMIT,
+        poll_interval: int = 2,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> MessageOutDto: 
+        """
+        Parameters:
+            - content: str.
+
+            - model: typing.Optional[Model].
+
+            - tools: typing.Optional[typing.Sequence[Tools]].
+
+            - conversation_id: typing.Optional[str].
+
+            - conversation_name: typing.Optional[str].
+
+            - poll_interval: int. The polling interval in seconds.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from athena import Model, Tools
+        from athena.client import AsyncAthena
+
+        client = AsyncAthena(
+            api_key="YOUR_API_KEY"
+        )
+        client.message.submit(
+            content="visit www.athenaintelligence.ai and summarize the website in one paragraph",
+            model=Model.GPT_4_TURBO_PREVIEW,
+            tools=[Tools.SEARCH, Tools.BROWSE],
+        )
+        """
+        response = await super().submit(
+          content=content,
+          model=model,
+          tools=tools,
+          conversation_id=conversation_id, 
+          conversation_name=conversation_name,
+          request_options=request_options)
+        message = await self.get(id=response.id)
+        while message.status != StatusEnum.RESPONDED \
+                or message.status != StatusEnum.ERROR:
+            time.sleep(poll_interval)
+            message = await self.get(id=message.id)
+        return message

athena_intelligence-0.1.13/PKG-INFO

@@ -1,76 +0,0 @@
-Metadata-Version: 2.1
-Name: athena-intelligence
-Version: 0.1.13
-Summary: 
-Requires-Python: >=3.8,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: httpx (>=0.21.2)
-Requires-Dist: pydantic (>=1.9.2)
-Requires-Dist: typing_extensions (>=4.0.0)
-Description-Content-Type: text/markdown
-
-<!-- Begin Title, generated by Fern  -->
-# Athena Python Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
-
-The Athena Python Library provides convenient access to the Athena API from applications written in Python.
-<!-- End Title  -->
-
-<!-- Begin Installation, generated by Fern  -->
-# Installation
-
-```sh
-pip install --upgrade athena-intelligence
-```
-<!-- End Installation  -->
-
-<!-- Begin Usage, generated by Fern  -->
-# Usage
-
-```python
-from athena.client import Athena
-
-client = Athena(
-    api_key="YOUR_API_KEY",
-)
-```
-<!-- End Usage  -->
-
-<!-- Begin Async Usage, generated by Fern  -->
-# Async Client
-
-```python
-from athena.client import AsyncAthena
-
-client = AsyncAthena(
-    api_key="YOUR_API_KEY",
-)
-```
-<!-- End Async Usage  -->
-
-<!-- Begin Status, generated by Fern  -->
-# Beta Status
-
-This SDK is in beta, and there may be breaking changes between versions without a major 
-version update. Therefore, we recommend pinning the package version to a specific version. 
-This way, you can install the same version each time without breaking changes.
-<!-- End Status  -->
-
-<!-- Begin Contributing, generated by Fern  -->
-# Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically. 
-Additions made directly to this library would have to be moved over to our generation code, 
-otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
- a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
-an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!
-<!-- End Contributing  -->
-
-

athena_intelligence-0.1.13/README.md

@@ -1,60 +0,0 @@
-<!-- Begin Title, generated by Fern  -->
-# Athena Python Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
-
-The Athena Python Library provides convenient access to the Athena API from applications written in Python.
-<!-- End Title  -->
-
-<!-- Begin Installation, generated by Fern  -->
-# Installation
-
-```sh
-pip install --upgrade athena-intelligence
-```
-<!-- End Installation  -->
-
-<!-- Begin Usage, generated by Fern  -->
-# Usage
-
-```python
-from athena.client import Athena
-
-client = Athena(
-    api_key="YOUR_API_KEY",
-)
-```
-<!-- End Usage  -->
-
-<!-- Begin Async Usage, generated by Fern  -->
-# Async Client
-
-```python
-from athena.client import AsyncAthena
-
-client = AsyncAthena(
-    api_key="YOUR_API_KEY",
-)
-```
-<!-- End Async Usage  -->
-
-<!-- Begin Status, generated by Fern  -->
-# Beta Status
-
-This SDK is in beta, and there may be breaking changes between versions without a major 
-version update. Therefore, we recommend pinning the package version to a specific version. 
-This way, you can install the same version each time without breaking changes.
-<!-- End Status  -->
-
-<!-- Begin Contributing, generated by Fern  -->
-# Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically. 
-Additions made directly to this library would have to be moved over to our generation code, 
-otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
- a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
-an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!
-<!-- End Contributing  -->
-