compass_api_sdk 0.1.7__tar.gz → 0.1.8__tar.gz

{compass_api_sdk-0.1.7 → compass_api_sdk-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.1.7
+Version: 0.1.8
 Summary: Compass API Python SDK
 Author: royalnine
 Requires-Python: >=3.9
@@ -98,7 +98,7 @@ It's also possible to write a standalone Python script without needing to set up
 # ]
 # ///
 
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 
 sdk = CompassAPISDK(
   # SDK arguments
@@ -128,14 +128,14 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 
 ```python
 # Synchronous Example
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -147,15 +147,15 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 async def main():
 
     async with CompassAPISDK(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as cas_client:
 
-        res = await compass_api_sdk.aave_v3.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = await cas_client.aave_v3.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
         # Handle response
         print(res)
@@ -177,14 +177,14 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `api_key_auth` parameter must be set when initializing the SDK client instance. For example:
 ```python
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -204,6 +204,7 @@ with CompassAPISDK(
 * [liquidity_change](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#liquidity_change) - Liquidity index
 * [user_position_summary](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#user_position_summary) - Positions - total
 * [user_position_per_token](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#user_position_per_token) - Positions - per token
+* [historical_transactions](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#historical_transactions) - Historical transactions
 * [supply](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#supply) - Supply/Lend
 * [borrow](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#borrow) - Borrow
 * [repay](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#repay) - Repay loans
@@ -288,15 +289,15 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from compassapisdk import CompassAPISDK, models
-from compassapisdk.utils import BackoffStrategy, RetryConfig
+from compass_api_sdk import CompassAPISDK, models
+from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -306,16 +307,16 @@ with CompassAPISDK(
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from compassapisdk import CompassAPISDK, models
-from compassapisdk.utils import BackoffStrategy, RetryConfig
+from compass_api_sdk import CompassAPISDK, models
+from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
 with CompassAPISDK(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -347,16 +348,16 @@ When custom error responses are specified for an operation, the SDK may also rai
 ### Example
 
 ```python
-from compassapisdk import CompassAPISDK, errors, models
+from compass_api_sdk import CompassAPISDK, errors, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
     res = None
     try:
 
-        res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
         # Handle response
         print(res)
@@ -377,15 +378,15 @@ with CompassAPISDK(
 
 The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
-    server_url="https://api.compasslabs.ai",
+    server_url="http://0.0.0.0:80",
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -402,7 +403,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu
 
 For example, you could specify a header for every request that this sdk makes as follows:
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
@@ -411,8 +412,8 @@ s = CompassAPISDK(client=http_client)
 
 or you could wrap the client with your own custom logic:
 ```python
-from compassapisdk import CompassAPISDK
-from compassapisdk.httpclient import AsyncHttpClient
+from compass_api_sdk import CompassAPISDK
+from compass_api_sdk.httpclient import AsyncHttpClient
 import httpx
 
 class CustomClient(AsyncHttpClient):
@@ -482,12 +483,12 @@ The `CompassAPISDK` class implements the context manager protocol and registers
 [context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
 
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 def main():
 
     with CompassAPISDK(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as cas_client:
         # Rest of application here...
 
 
@@ -496,7 +497,7 @@ async def amain():
 
     async with CompassAPISDK(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as cas_client:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->
@@ -508,11 +509,11 @@ You can setup your SDK to emit debug logs for SDK requests and responses.
 
 You can pass your own logger class directly into your SDK.
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 import logging
 
 logging.basicConfig(level=logging.DEBUG)
-s = CompassAPISDK(debug_logger=logging.getLogger("compassapisdk"))
+s = CompassAPISDK(debug_logger=logging.getLogger("compass_api_sdk"))
 ```
 <!-- End Debugging [debug] -->
 

{compass_api_sdk-0.1.7 → compass_api_sdk-0.1.8}/README-PYPI.md

@@ -81,7 +81,7 @@ It's also possible to write a standalone Python script without needing to set up
 # ]
 # ///
 
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 
 sdk = CompassAPISDK(
   # SDK arguments
@@ -111,14 +111,14 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 
 ```python
 # Synchronous Example
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -130,15 +130,15 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 async def main():
 
     async with CompassAPISDK(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as cas_client:
 
-        res = await compass_api_sdk.aave_v3.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = await cas_client.aave_v3.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
         # Handle response
         print(res)
@@ -160,14 +160,14 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `api_key_auth` parameter must be set when initializing the SDK client instance. For example:
 ```python
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -187,6 +187,7 @@ with CompassAPISDK(
 * [liquidity_change](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#liquidity_change) - Liquidity index
 * [user_position_summary](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#user_position_summary) - Positions - total
 * [user_position_per_token](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#user_position_per_token) - Positions - per token
+* [historical_transactions](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#historical_transactions) - Historical transactions
 * [supply](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#supply) - Supply/Lend
 * [borrow](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#borrow) - Borrow
 * [repay](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#repay) - Repay loans
@@ -271,15 +272,15 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from compassapisdk import CompassAPISDK, models
-from compassapisdk.utils import BackoffStrategy, RetryConfig
+from compass_api_sdk import CompassAPISDK, models
+from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -289,16 +290,16 @@ with CompassAPISDK(
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from compassapisdk import CompassAPISDK, models
-from compassapisdk.utils import BackoffStrategy, RetryConfig
+from compass_api_sdk import CompassAPISDK, models
+from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
 with CompassAPISDK(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -330,16 +331,16 @@ When custom error responses are specified for an operation, the SDK may also rai
 ### Example
 
 ```python
-from compassapisdk import CompassAPISDK, errors, models
+from compass_api_sdk import CompassAPISDK, errors, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
     res = None
     try:
 
-        res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
         # Handle response
         print(res)
@@ -360,15 +361,15 @@ with CompassAPISDK(
 
 The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
-from compassapisdk import CompassAPISDK, models
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
-    server_url="https://api.compasslabs.ai",
+    server_url="http://0.0.0.0:80",
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as cas_client:
 
-    res = compass_api_sdk.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -385,7 +386,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu
 
 For example, you could specify a header for every request that this sdk makes as follows:
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
@@ -394,8 +395,8 @@ s = CompassAPISDK(client=http_client)
 
 or you could wrap the client with your own custom logic:
 ```python
-from compassapisdk import CompassAPISDK
-from compassapisdk.httpclient import AsyncHttpClient
+from compass_api_sdk import CompassAPISDK
+from compass_api_sdk.httpclient import AsyncHttpClient
 import httpx
 
 class CustomClient(AsyncHttpClient):
@@ -465,12 +466,12 @@ The `CompassAPISDK` class implements the context manager protocol and registers
 [context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
 
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 def main():
 
     with CompassAPISDK(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as cas_client:
         # Rest of application here...
 
 
@@ -479,7 +480,7 @@ async def amain():
 
     async with CompassAPISDK(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as cas_client:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->
@@ -491,11 +492,11 @@ You can setup your SDK to emit debug logs for SDK requests and responses.
 
 You can pass your own logger class directly into your SDK.
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK
 import logging
 
 logging.basicConfig(level=logging.DEBUG)
-s = CompassAPISDK(debug_logger=logging.getLogger("compassapisdk"))
+s = CompassAPISDK(debug_logger=logging.getLogger("compass_api_sdk"))
 ```
 <!-- End Debugging [debug] -->
 

{compass_api_sdk-0.1.7 → compass_api_sdk-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compass_api_sdk"
-version = "0.1.7"
+version = "0.1.8"
 description = "Compass API Python SDK"
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -13,12 +13,12 @@ dependencies = [
 [tool.poetry]
 repository = "https://github.com/CompassLabs/mono.git"
 packages = [
-    { include = "compassapisdk", from = "src" }
+    { include = "compass_api_sdk", from = "src" }
 ]
-include = ["py.typed", "src/compassapisdk/py.typed"]
+include = ["py.typed", "src/compass_api_sdk/py.typed"]
 
 [tool.setuptools.package-data]
-"*" = ["py.typed", "src/compassapisdk/py.typed"]
+"*" = ["py.typed", "src/compass_api_sdk/py.typed"]
 
 [virtualenvs]
 in-project = true

compass_api_sdk-0.1.8/src/compass_api_sdk/_hooks/registration.py

@@ -0,0 +1,13 @@
+from .types import Hooks
+
+
+# This file is only ever generated once on the first generation and then is free to be modified.
+# Any hooks you wish to add should be registered in the init_hooks function. Feel free to define them
+# in this file or in separate files in the hooks folder.
+
+
+def init_hooks(hooks: Hooks):
+    # pylint: disable=unused-argument
+    """Add hooks by calling hooks.register{sdk_init/before_request/after_success/after_error}Hook
+    with an instance of a hook that implements that specific Hook interface
+    Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance"""

{compass_api_sdk-0.1.7/src/compassapisdk → compass_api_sdk-0.1.8/src/compass_api_sdk}/_hooks/sdkhooks.py

@@ -12,7 +12,7 @@ from .types import (
     Hooks,
 )
 from typing import List, Optional, Tuple
-from compassapisdk.httpclient import HttpClient
+from compass_api_sdk.httpclient import HttpClient
 
 
 class SDKHooks(Hooks):

{compass_api_sdk-0.1.7/src/compassapisdk → compass_api_sdk-0.1.8/src/compass_api_sdk}/_hooks/types.py

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from abc import ABC, abstractmethod
-from compassapisdk.httpclient import HttpClient
+from compass_api_sdk.httpclient import HttpClient
 import httpx
 from typing import Any, Callable, List, Optional, Tuple, Union
 

{compass_api_sdk-0.1.7/src/compassapisdk → compass_api_sdk-0.1.8/src/compass_api_sdk}/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "compass_api_sdk"
-__version__: str = "0.1.7"
+__version__: str = "0.1.8"
 __openapi_doc_version__: str = "0.0.1"
 __gen_version__: str = "2.597.9"
-__user_agent__: str = "speakeasy-sdk/python 0.1.7 2.597.9 0.0.1 compass_api_sdk"
+__user_agent__: str = "speakeasy-sdk/python 0.1.8 2.597.9 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None: