crypticorn 2.2.1__tar.gz → 2.2.2__tar.gz

{crypticorn-2.2.1 → crypticorn-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.2.1
+Version: 2.2.2
 Summary: Maximise Your Crypto Trading Profits with AI Predictions
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/client.py

@@ -6,6 +6,8 @@ from crypticorn.metrics import MetricsClient
 from crypticorn.auth import AuthClient
 from crypticorn.common import BaseUrl, ApiVersion, Service, apikey_header as aph
 import warnings
+
+
 class ApiClient:
     """
     The official client for interacting with the Crypticorn API.
@@ -20,25 +22,27 @@ class ApiClient:
         base_url: BaseUrl = BaseUrl.PROD,
     ):
         self.base_url = base_url
-        '''The base URL the client will use to connect to the API.'''
+        """The base URL the client will use to connect to the API."""
         self.api_key = api_key
-        '''The API key to use for authentication.'''
+        """The API key to use for authentication."""
         self.jwt = jwt
-        '''The JWT to use for authentication.'''
+        """The JWT to use for authentication."""
 
         self.hive = HiveClient(self._get_default_config(Service.HIVE))
         self.trade = TradeClient(self._get_default_config(Service.TRADE))
         self.klines = KlinesClient(self._get_default_config(Service.KLINES))
         self.pay = PayClient(self._get_default_config(Service.PAY))
         self.metrics = MetricsClient(self._get_default_config(Service.METRICS))
-        self.auth = AuthClient(self._get_default_config(Service.AUTH)) 
+        self.auth = AuthClient(self._get_default_config(Service.AUTH))
 
     def __new__(cls, *args, **kwargs):
         if kwargs.get("api_key") and not kwargs.get("jwt"):
             # auth-service does not allow api_key
-            warnings.warn("The auth module does only accept JWT to be used to authenticate. If you use this module, you need to provide a JWT.")
+            warnings.warn(
+                "The auth module does only accept JWT to be used to authenticate. If you use this module, you need to provide a JWT."
+            )
         return super().__new__(cls)
-    
+
     async def close(self):
         """Close all client sessions."""
         clients = [
@@ -54,7 +58,9 @@ class ApiClient:
             if hasattr(client, "close"):
                 await client.close()
 
-    def _get_default_config(self, service: Service, version: ApiVersion = ApiVersion.V1):
+    def _get_default_config(
+        self, service: Service, version: ApiVersion = ApiVersion.V1
+    ):
         """
         Get the default configuration for a given service.
         """
@@ -62,9 +68,11 @@ class ApiClient:
             host=f"{self.base_url}/{version}/{service}",
             access_token=self.jwt,
             api_key={aph.scheme_name: self.api_key} if self.api_key else None,
-            api_key_prefix=({aph.scheme_name: aph.model.name} if self.api_key else None),
+            api_key_prefix=(
+                {aph.scheme_name: aph.model.name} if self.api_key else None
+            ),
         )
-    
+
     def configure(self, config: Configuration, sub_client: any):
         """
         Update a sub-client's configuration by overriding with the values set in the new config.
@@ -104,4 +112,3 @@ class ApiClient:
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):
         await self.close()
-

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/common/__init__.py

@@ -1,4 +1,5 @@
 from crypticorn.common.errors import *
 from crypticorn.common.scopes import *
 from crypticorn.common.urls import *
-from crypticorn.common.auth import *
+from crypticorn.common.pydantic import *
+from crypticorn.common.auth import *

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/common/auth.py

@@ -31,6 +31,7 @@ apikey_header = APIKeyHeader(
     description="The API key to use for authentication.",
 )
 
+
 # Auth Handler
 class AuthHandler:
     """

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/common/pydantic.py

@@ -6,8 +6,8 @@ from pydantic.fields import FieldInfo
 
 
 def partial_model(model: Type[BaseModel]) -> Type[BaseModel]:
-    '''Marks all fields of a model as optional. Useful for updating models.
-    
+    """Marks all fields of a model as optional. Useful for updating models.
+
     >>> @partial_model
     >>> class Model(BaseModel):
     >>>     i: int
@@ -15,18 +15,22 @@ def partial_model(model: Type[BaseModel]) -> Type[BaseModel]:
     >>>     s: str
 
     >>> Model(i=1)
-    '''
-    def make_field_optional(field: FieldInfo, default: Any = None) -> Tuple[Any, FieldInfo]:
+    """
+
+    def make_field_optional(
+        field: FieldInfo, default: Any = None
+    ) -> Tuple[Any, FieldInfo]:
         new = deepcopy(field)
         new.default = default
         new.annotation = Optional[field.annotation]  # type: ignore
-        return new.annotation, new 
+        return new.annotation, new
+
     return create_model(
-        f'Partial{model.__name__}',
+        model.__name__,
         __base__=model,
         __module__=model.__module__,
         **{
             field_name: make_field_optional(field_info)
             for field_name, field_info in model.model_fields.items()
-        }
-    )
+        },
+    )

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/common/urls.py

@@ -1,11 +1,13 @@
 from enum import StrEnum
 
+
 class ApiEnv(StrEnum):
     PROD = "prod"
     DEV = "dev"
     LOCAL = "local"
     DOCKER = "docker"
 
+
 class BaseUrl(StrEnum):
     PROD = "https://api.crypticorn.com"
     DEV = "https://api.crypticorn.dev"

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/klines/client/configuration.py

@@ -190,9 +190,7 @@ class Configuration:
         debug: Optional[bool] = None,
     ) -> None:
         """Constructor"""
-        self._base_path = (
-            "http://localhost/v1/klines" if host is None else host
-        )
+        self._base_path = "http://localhost/v1/klines" if host is None else host
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/metrics/__init__.py

@@ -1,4 +1,6 @@
 from crypticorn.metrics.client import *
 from crypticorn.metrics.main import MetricsClient
 
-__all__ = ["MetricsClient", ]
+__all__ = [
+    "MetricsClient",
+]

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/metrics/main.py

@@ -38,7 +38,6 @@ class MetricsClient:
         self.exchanges = ExchangesApi(self.base_client)
 
 
-
 class MarketcapApiWrapper(MarketcapApi):
     """
     A wrapper for the MarketcapApi class.
@@ -77,8 +76,8 @@ class MarketcapApiWrapper(MarketcapApi):
         )
         json_response = await response.json()
         df = pd.DataFrame(json_response["data"])
-        df.rename(columns={df.columns[0]: 'timestamp'}, inplace=True)
-        df['timestamp'] = pd.to_datetime(df['timestamp']).astype("int64") // 10 ** 9
+        df.rename(columns={df.columns[0]: "timestamp"}, inplace=True)
+        df["timestamp"] = pd.to_datetime(df["timestamp"]).astype("int64") // 10**9
         return df
 
 
@@ -97,6 +96,8 @@ class TokensApiWrapper(TokensApi):
         """
         Get the tokens in a pandas dataframe
         """
-        response = await self.get_stable_and_wrapped_tokens_without_preload_content(token_type=token_type)
+        response = await self.get_stable_and_wrapped_tokens_without_preload_content(
+            token_type=token_type
+        )
         json_data = await response.json()
-        return pd.DataFrame(json_data['data'])
+        return pd.DataFrame(json_data["data"])

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/pay/client/__init__.py

@@ -41,6 +41,9 @@ from crypticorn.pay.client.models.now_create_invoice_res import NowCreateInvoice
 from crypticorn.pay.client.models.now_fee_structure import NowFeeStructure
 from crypticorn.pay.client.models.now_payment_status import NowPaymentStatus
 from crypticorn.pay.client.models.now_webhook_payload import NowWebhookPayload
+from crypticorn.pay.client.models.partial_product_update_model import (
+    PartialProductUpdateModel,
+)
 from crypticorn.pay.client.models.payment_status import PaymentStatus
 from crypticorn.pay.client.models.product_model import ProductModel
 from crypticorn.pay.client.models.product_subs_model import ProductSubsModel

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/pay/client/api/now_payments_api.py

@@ -313,7 +313,7 @@ class NOWPaymentsApi:
     ) -> NowAPIStatusRes:
         """Get Status
 
-        Get NOWPayments API status
+        Get the status of the NOWPayments API
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -373,7 +373,7 @@ class NOWPaymentsApi:
     ) -> ApiResponse[NowAPIStatusRes]:
         """Get Status
 
-        Get NOWPayments API status
+        Get the status of the NOWPayments API
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -433,7 +433,7 @@ class NOWPaymentsApi:
     ) -> RESTResponseType:
         """Get Status
 
-        Get NOWPayments API status
+        Get the status of the NOWPayments API
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

{crypticorn-2.2.1 → crypticorn-2.2.2}/crypticorn/pay/client/api/payments_api.py

@@ -16,8 +16,9 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import StrictStr
+from pydantic import Field, StrictStr
 from typing import List, Optional
+from typing_extensions import Annotated
 from crypticorn.pay.client.models.product_subs_model import ProductSubsModel
 from crypticorn.pay.client.models.unified_payment_model import UnifiedPaymentModel
 
@@ -41,7 +42,10 @@ class PaymentsApi:
     @validate_call
     async def get_latest_payment_from_invoice(
         self,
-        invoice_id: StrictStr,
+        invoice_id: Annotated[
+            StrictStr,
+            Field(description="The invoice ID to get the latest payment from"),
+        ],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -56,9 +60,9 @@ class PaymentsApi:
     ) -> UnifiedPaymentModel:
         """Get Latest Payment From Invoice
 
-        Get the latest payment from an invoice
+        Get the latest payment by a user from an invoice
 
-        :param invoice_id: (required)
+        :param invoice_id: The invoice ID to get the latest payment from (required)
         :type invoice_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -106,7 +110,10 @@ class PaymentsApi:
     @validate_call
     async def get_latest_payment_from_invoice_with_http_info(
         self,
-        invoice_id: StrictStr,
+        invoice_id: Annotated[
+            StrictStr,
+            Field(description="The invoice ID to get the latest payment from"),
+        ],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -121,9 +128,9 @@ class PaymentsApi:
     ) -> ApiResponse[UnifiedPaymentModel]:
         """Get Latest Payment From Invoice
 
-        Get the latest payment from an invoice
+        Get the latest payment by a user from an invoice
 
-        :param invoice_id: (required)
+        :param invoice_id: The invoice ID to get the latest payment from (required)
         :type invoice_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -171,7 +178,10 @@ class PaymentsApi:
     @validate_call
     async def get_latest_payment_from_invoice_without_preload_content(
         self,
-        invoice_id: StrictStr,
+        invoice_id: Annotated[
+            StrictStr,
+            Field(description="The invoice ID to get the latest payment from"),
+        ],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -186,9 +196,9 @@ class PaymentsApi:
     ) -> RESTResponseType:
         """Get Latest Payment From Invoice
 
-        Get the latest payment from an invoice
+        Get the latest payment by a user from an invoice
 
-        :param invoice_id: (required)
+        :param invoice_id: The invoice ID to get the latest payment from (required)
         :type invoice_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -302,7 +312,7 @@ class PaymentsApi:
     ) -> List[UnifiedPaymentModel]:
         """Get Payments
 
-        Get combined payment history for a user across all payment services.
+        Get the combined payment history for a user across all payment services.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -362,7 +372,7 @@ class PaymentsApi:
     ) -> ApiResponse[List[UnifiedPaymentModel]]:
         """Get Payments
 
-        Get combined payment history for a user across all payment services.
+        Get the combined payment history for a user across all payment services.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -422,7 +432,7 @@ class PaymentsApi:
     ) -> RESTResponseType:
         """Get Payments
 
-        Get combined payment history for a user across all payment services.
+        Get the combined payment history for a user across all payment services.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -515,7 +525,12 @@ class PaymentsApi:
     @validate_call
     async def get_subscriptions(
         self,
-        user_id: Optional[StrictStr] = None,
+        user_id: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The user ID to get subscriptions for. Defaults to the authenticated user."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -530,8 +545,9 @@ class PaymentsApi:
     ) -> List[ProductSubsModel]:
         """Get Subscriptions
 
+        Get all subscriptions for a user. Subscriptions are the products a user has subscribed to. Returns both active and inactive subscriptions.
 
-        :param user_id:
+        :param user_id: The user ID to get subscriptions for. Defaults to the authenticated user.
         :type user_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -579,7 +595,12 @@ class PaymentsApi:
     @validate_call
     async def get_subscriptions_with_http_info(
         self,
-        user_id: Optional[StrictStr] = None,
+        user_id: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The user ID to get subscriptions for. Defaults to the authenticated user."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -594,8 +615,9 @@ class PaymentsApi:
     ) -> ApiResponse[List[ProductSubsModel]]:
         """Get Subscriptions
 
+        Get all subscriptions for a user. Subscriptions are the products a user has subscribed to. Returns both active and inactive subscriptions.
 
-        :param user_id:
+        :param user_id: The user ID to get subscriptions for. Defaults to the authenticated user.
         :type user_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -643,7 +665,12 @@ class PaymentsApi:
     @validate_call
     async def get_subscriptions_without_preload_content(
         self,
-        user_id: Optional[StrictStr] = None,
+        user_id: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="The user ID to get subscriptions for. Defaults to the authenticated user."
+            ),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -658,8 +685,9 @@ class PaymentsApi:
     ) -> RESTResponseType:
         """Get Subscriptions
 
+        Get all subscriptions for a user. Subscriptions are the products a user has subscribed to. Returns both active and inactive subscriptions.
 
-        :param user_id:
+        :param user_id: The user ID to get subscriptions for. Defaults to the authenticated user.
         :type user_id: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request