compass_api_sdk 0.3.5__py3-none-any.whl → 0.3.8__py3-none-any.whl

{compassapisdk → compass_api_sdk}/sdk.py

@@ -5,23 +5,23 @@ from .httpclient import AsyncHttpClient, ClientOwner, HttpClient, close_clients
 from .sdkconfiguration import SDKConfiguration
 from .utils.logger import Logger, get_default_logger
 from .utils.retries import RetryConfig
-from compassapisdk import models, utils
-from compassapisdk._hooks import SDKHooks
-from compassapisdk.aave_v3 import AaveV3
-from compassapisdk.aerodrome_slipstream import AerodromeSlipstream
-from compassapisdk.morpho import Morpho
-from compassapisdk.sky import Sky
-from compassapisdk.token_sdk import TokenSDK
-from compassapisdk.transaction_batching import TransactionBatching
-from compassapisdk.types import OptionalNullable, UNSET
-from compassapisdk.uniswap_v3 import UniswapV3
-from compassapisdk.universal import Universal
+from compass_api_sdk import models, utils
+from compass_api_sdk._hooks import SDKHooks
+from compass_api_sdk.aave_v3 import AaveV3
+from compass_api_sdk.aerodrome_slipstream import AerodromeSlipstream
+from compass_api_sdk.morpho import Morpho
+from compass_api_sdk.sky import Sky
+from compass_api_sdk.token_sdk import TokenSDK
+from compass_api_sdk.transaction_batching import TransactionBatching
+from compass_api_sdk.types import OptionalNullable, UNSET
+from compass_api_sdk.uniswap_v3 import UniswapV3
+from compass_api_sdk.universal import Universal
 import httpx
 from typing import Any, Callable, Dict, Optional, Union, cast
 import weakref
 
 
-class CompassAPISDK(BaseSDK):
+class CompassAPI(BaseSDK):
     r"""Compass API: Compass Labs DeFi API"""
 
     aave_v3: AaveV3

{compassapisdk → compass_api_sdk}/sdkconfiguration.py

@@ -9,8 +9,8 @@ from ._version import (
 )
 from .httpclient import AsyncHttpClient, HttpClient
 from .utils import Logger, RetryConfig, remove_suffix
-from compassapisdk import models
-from compassapisdk.types import OptionalNullable, UNSET
+from compass_api_sdk import models
+from compass_api_sdk.types import OptionalNullable, UNSET
 from dataclasses import dataclass
 from pydantic import Field
 from typing import Callable, Dict, Optional, Tuple, Union

{compassapisdk → compass_api_sdk}/sky.py

@@ -1,9 +1,9 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from compassapisdk import errors, models, utils
-from compassapisdk._hooks import HookContext
-from compassapisdk.types import OptionalNullable, UNSET
+from compass_api_sdk import errors, models, utils
+from compass_api_sdk._hooks import HookContext
+from compass_api_sdk.types import OptionalNullable, UNSET
 from typing import Any, Mapping, Optional, Union
 
 
@@ -889,8 +889,6 @@ class Sky(BaseSDK):
 
         Withdraw USDS for sUSDS to stop earning yield.
 
-        There are no fees.
-
         :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the withdrawn USDS. Defaults to the sender.
@@ -997,8 +995,6 @@ class Sky(BaseSDK):
 
         Withdraw USDS for sUSDS to stop earning yield.
 
-        There are no fees.
-
         :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the withdrawn USDS. Defaults to the sender.

{compassapisdk → compass_api_sdk}/token_sdk.py

@@ -1,9 +1,9 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from compassapisdk import errors, models, utils
-from compassapisdk._hooks import HookContext
-from compassapisdk.types import OptionalNullable, UNSET
+from compass_api_sdk import errors, models, utils
+from compass_api_sdk._hooks import HookContext
+from compass_api_sdk.types import OptionalNullable, UNSET
 from typing import Any, Mapping, Optional, Union
 
 
@@ -640,7 +640,7 @@ class TokenSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UnsignedTransaction:
-        r"""Transfer ETH or ERC20 Tokens
+        r"""Transfer ETH or ERC20 Tokens.
 
         Sends native ETH or ERC20 tokens from the sender's address to another address.
 
@@ -757,7 +757,7 @@ class TokenSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UnsignedTransaction:
-        r"""Transfer ETH or ERC20 Tokens
+        r"""Transfer ETH or ERC20 Tokens.
 
         Sends native ETH or ERC20 tokens from the sender's address to another address.
 

{compassapisdk → compass_api_sdk}/transaction_batching.py

@@ -1,9 +1,9 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from compassapisdk import errors, models, utils
-from compassapisdk._hooks import HookContext
-from compassapisdk.types import OptionalNullable, UNSET
+from compass_api_sdk import errors, models, utils
+from compass_api_sdk._hooks import HookContext
+from compass_api_sdk.types import OptionalNullable, UNSET
 from typing import Any, List, Mapping, Optional, Union
 
 

{compassapisdk → compass_api_sdk}/uniswap_v3.py

@@ -1,9 +1,9 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from compassapisdk import errors, models, utils
-from compassapisdk._hooks import HookContext
-from compassapisdk.types import OptionalNullable, UNSET
+from compass_api_sdk import errors, models, utils
+from compass_api_sdk._hooks import HookContext
+from compass_api_sdk.types import OptionalNullable, UNSET
 from typing import Any, Mapping, Optional, Union
 
 

{compassapisdk → compass_api_sdk}/universal.py

@@ -1,9 +1,9 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from .basesdk import BaseSDK
-from compassapisdk import errors, models, utils
-from compassapisdk._hooks import HookContext
-from compassapisdk.types import OptionalNullable, UNSET
+from compass_api_sdk import errors, models, utils
+from compass_api_sdk._hooks import HookContext
+from compass_api_sdk.types import OptionalNullable, UNSET
 from typing import Any, Mapping, Optional, Union
 
 
@@ -1061,7 +1061,7 @@ class Universal(BaseSDK):
     ) -> models.UnsignedTransaction:
         r"""Wrap ETH
 
-        Wrapping ETH creates an ERC-20 compliant form of ETH that is typically needed for
+        Wrapping ETH creates an ERC20 compliant form of ETH that is typically needed for
         it to be traded on DeFi protocols.
 
         :param amount: The amount of ETH to wrap.
@@ -1170,7 +1170,7 @@ class Universal(BaseSDK):
     ) -> models.UnsignedTransaction:
         r"""Wrap ETH
 
-        Wrapping ETH creates an ERC-20 compliant form of ETH that is typically needed for
+        Wrapping ETH creates an ERC20 compliant form of ETH that is typically needed for
         it to be traded on DeFi protocols.
 
         :param amount: The amount of ETH to wrap.

{compass_api_sdk-0.3.5.dist-info → compass_api_sdk-0.3.8.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.3.5
-Summary: Compass API Python SDK
+Version: 0.3.8
+Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2
 Classifier: Programming Language :: Python :: 3
@@ -18,13 +18,6 @@ Description-Content-Type: text/markdown
 
 Developer-friendly & type-safe Python SDK specifically catered to leverage *compass_api_sdk* API.
 
-<div align="left">
-    <a href="https://opensource.org/licenses/MIT">
-        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
-    </a>
-</div>
-
-
 <!-- Start Summary [summary] -->
 ## Summary
 
@@ -97,9 +90,9 @@ It's also possible to write a standalone Python script without needing to set up
 # ]
 # ///
 
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPI
 
-sdk = CompassAPISDK(
+sdk = CompassAPI(
   # SDK arguments
 )
 
@@ -127,14 +120,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 CompassAPI, models
 
 
-with CompassAPISDK(
+with CompassAPI(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as compass_api:
 
-    res = compass_api_sdk.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
+    res = compass_api.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
 
     # Handle response
     print(res)
@@ -146,15 +139,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 CompassAPI, models
 
 async def main():
 
-    async with CompassAPISDK(
+    async with CompassAPI(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as compass_api:
 
-        res = await compass_api_sdk.aave_v3.std_rate_async(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
+        res = await compass_api.aave_v3.std_rate_async(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
 
         # Handle response
         print(res)
@@ -176,14 +169,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 CompassAPI, models
 
 
-with CompassAPISDK(
+with CompassAPI(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as compass_api:
 
-    res = compass_api_sdk.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
+    res = compass_api.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
 
     # Handle response
     print(res)
@@ -227,9 +220,12 @@ with CompassAPISDK(
 ### [morpho](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md)
 
 * [vaults](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#vaults) - Get Vaults
+* [vault](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#vault) - Get Vault
 * [vault_position](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#vault_position) - Check Vault Position
 * [markets](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#markets) - Get Markets
+* [market](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#market) - Get Market
 * [market_position](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#market_position) - Check Market Position
+* [user_position](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#user_position) - Check User Position
 * [allowance](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#allowance) - Set Allowance for Vault
 * [deposit](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#deposit) - Deposit to Vault
 * [withdraw](https://github.com/CompassLabs/mono/blob/master/docs/sdks/morpho/README.md#withdraw) - Withdraw from Vault
@@ -251,7 +247,7 @@ with CompassAPISDK(
 * [address](https://github.com/CompassLabs/mono/blob/master/docs/sdks/tokensdk/README.md#address) - Token Address
 * [price](https://github.com/CompassLabs/mono/blob/master/docs/sdks/tokensdk/README.md#price) - Token Price
 * [balance](https://github.com/CompassLabs/mono/blob/master/docs/sdks/tokensdk/README.md#balance) - Token Balance
-* [transfer](https://github.com/CompassLabs/mono/blob/master/docs/sdks/tokensdk/README.md#transfer) - Transfer ETH or ERC20 Tokens
+* [transfer](https://github.com/CompassLabs/mono/blob/master/docs/sdks/tokensdk/README.md#transfer) - Transfer ETH or ERC20 Tokens.
 
 ### [transaction_batching](https://github.com/CompassLabs/mono/blob/master/docs/sdks/transactionbatching/README.md)
 
@@ -293,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 CompassAPI, models
+from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
-with CompassAPISDK(
+with CompassAPI(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as compass_api:
 
-    res = compass_api_sdk.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7,
+    res = compass_api.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -311,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 CompassAPI, models
+from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
-with CompassAPISDK(
+with CompassAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as compass_api:
 
-    res = compass_api_sdk.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
+    res = compass_api.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
 
     # Handle response
     print(res)
@@ -352,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 CompassAPI, errors, models
 
 
-with CompassAPISDK(
+with CompassAPI(
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as compass_api:
     res = None
     try:
 
-        res = compass_api_sdk.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
+        res = compass_api.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
 
         # Handle response
         print(res)
@@ -382,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 CompassAPI, models
 
 
-with CompassAPISDK(
+with CompassAPI(
     server_url="https://api.compasslabs.ai",
     api_key_auth="<YOUR_API_KEY_HERE>",
-) as compass_api_sdk:
+) as compass_api:
 
-    res = compass_api_sdk.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
+    res = compass_api.aave_v3.std_rate(chain=models.AaveStdRateChain.ETHEREUM_MAINNET, token=models.AaveStdRateToken.USDC, days=7)
 
     # Handle response
     print(res)
@@ -407,17 +403,17 @@ 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 CompassAPI
 import httpx
 
 http_client = httpx.Client(headers={"x-custom-header": "someValue"})
-s = CompassAPISDK(client=http_client)
+s = CompassAPI(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 CompassAPI
+from compass_api_sdk.httpclient import AsyncHttpClient
 import httpx
 
 class CustomClient(AsyncHttpClient):
@@ -475,33 +471,33 @@ class CustomClient(AsyncHttpClient):
             extensions=extensions,
         )
 
-s = CompassAPISDK(async_client=CustomClient(httpx.AsyncClient()))
+s = CompassAPI(async_client=CustomClient(httpx.AsyncClient()))
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
 <!-- Start Resource Management [resource-management] -->
 ## Resource Management
 
-The `CompassAPISDK` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
+The `CompassAPI` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
 
 [context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
 
 ```python
-from compassapisdk import CompassAPISDK
+from compass_api_sdk import CompassAPI
 def main():
 
-    with CompassAPISDK(
+    with CompassAPI(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as compass_api:
         # Rest of application here...
 
 
 # Or when using async:
 async def amain():
 
-    async with CompassAPISDK(
+    async with CompassAPI(
         api_key_auth="<YOUR_API_KEY_HERE>",
-    ) as compass_api_sdk:
+    ) as compass_api:
         # Rest of application here...
 ```
 <!-- End Resource Management [resource-management] -->
@@ -513,16 +509,14 @@ 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 CompassAPI
 import logging
 
 logging.basicConfig(level=logging.DEBUG)
-s = CompassAPISDK(debug_logger=logging.getLogger("compassapisdk"))
+s = CompassAPI(debug_logger=logging.getLogger("compass_api_sdk"))
 ```
 <!-- End Debugging [debug] -->
 
-<!-- Placeholder for Future Speakeasy SDK Sections -->
-
 # Development
 
 ## Maturity
@@ -536,3 +530,5 @@ looking for the latest version.
 While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
 We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
 
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+