crypticorn 2.4.5__tar.gz → 2.4.7__tar.gz

{crypticorn-2.4.5 → crypticorn-2.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.4.5
+Version: 2.4.7
 Summary: Maximise Your Crypto Trading Profits with AI Predictions
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
@@ -21,19 +21,23 @@ Requires-Dist: aiohttp<4.0.0,>=3.8.4
 Requires-Dist: aiohttp-retry<3.0.0,>=2.8.3
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: typing-extensions<5.0.0,>=4.7.1
-Requires-Dist: pandas<3.0.0,>=2.2.0
 Requires-Dist: requests<3.0.0,>=2.32.0
 Requires-Dist: tqdm<5.0.0,>=4.67.0
 Provides-Extra: dev
 Requires-Dist: streamlit; extra == "dev"
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
 Requires-Dist: openapi-generator-cli<8.0.0,>=7.12.0; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest==8.3.5; extra == "test"
 Requires-Dist: pytest-asyncio==0.26.0; extra == "test"
 Requires-Dist: pytest-cov==6.1.1; extra == "test"
 Requires-Dist: python-dotenv==1.0.1; extra == "test"
+Provides-Extra: extra
+Requires-Dist: pandas<3.0.0,>=2.2.0; extra == "extra"
 
 # What is Crypticorn?
 
@@ -49,6 +53,8 @@ cryptocurrency market.
 
 ## Installation
 
+>Python 3.10+ required
+
 You can install the latest stable version from PyPi:
 ```bash
 pip install crypticorn
@@ -95,7 +101,12 @@ client = ApiClient(base_url=BaseUrl.Prod, api_key="your-api-key")
 asyncio.run(client.pay.models.get_products())
 asyncio.run(client.close())
 ```
+...or wrapped in a function
+async def main():
+    await client.pay.products.get_products()
 
+asyncio.run(main())
+asyncio.run(client.close())
 ## Response Types
 
 There are three different available output formats you can choose from:

{crypticorn-2.4.5 → crypticorn-2.4.7}/README.md

@@ -12,6 +12,8 @@ cryptocurrency market.
 
 ## Installation
 
+>Python 3.10+ required
+
 You can install the latest stable version from PyPi:
 ```bash
 pip install crypticorn
@@ -58,7 +60,12 @@ client = ApiClient(base_url=BaseUrl.Prod, api_key="your-api-key")
 asyncio.run(client.pay.models.get_products())
 asyncio.run(client.close())
 ```
+...or wrapped in a function
+async def main():
+    await client.pay.products.get_products()
 
+asyncio.run(main())
+asyncio.run(client.close())
 ## Response Types
 
 There are three different available output formats you can choose from:

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/client.py

@@ -106,7 +106,7 @@ class ApiClient:
         new_config = sub_client.config
         for attr in vars(config):
             new_value = getattr(config, attr)
-            if new_value is not None:
+            if new_value:
                 setattr(new_config, attr, new_value)
 
         if sub_client == self.hive:

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/common/auth.py

@@ -9,7 +9,7 @@ from crypticorn.common import (
     Scope,
     Service,
 )
-from fastapi import Depends, HTTPException, Query, status
+from fastapi import Depends, HTTPException, Query, status, WebSocketException
 from fastapi.security import (
     HTTPAuthorizationCredentials,
     SecurityScopes,
@@ -183,7 +183,7 @@ class AuthHandler:
         Verifies the API key and checks if the user scopes are a subset of the API scopes.
         Use this function if you only want to allow access via the API key.
         """
-        return await self.api_key_auth(api_key=api_key, sec=sec)
+        return await self.ws_combined_auth(bearer=None, api_key=api_key, sec=sec)
 
     async def ws_bearer_auth(
         self,
@@ -194,12 +194,7 @@ class AuthHandler:
         Verifies the bearer token and checks if the user scopes are a subset of the API scopes.
         Use this function if you only want to allow access via the bearer token.
         """
-        credentials = (
-            HTTPAuthorizationCredentials(scheme="Bearer", credentials=bearer)
-            if bearer
-            else None
-        )
-        return await self.bearer_auth(bearer=credentials, sec=sec)
+        return await self.ws_combined_auth(bearer=bearer, api_key=None, sec=sec)
 
     async def ws_combined_auth(
         self,
@@ -216,4 +211,7 @@ class AuthHandler:
             if bearer
             else None
         )
-        return await self.combined_auth(bearer=credentials, api_key=api_key, sec=sec)
+        response = await self.combined_auth(bearer=credentials, api_key=api_key, sec=sec)
+        if isinstance(response, HTTPException):
+            raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION, reason=response.detail)
+        return response

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/common/errors.py

@@ -7,7 +7,7 @@ logger = logging.getLogger(__name__)
 
 class Fallback(EnumMeta):
     """Fallback to UNKNOWN_ERROR for error codes not yet published to PyPI."""
-    
+
     def __getattr__(cls, name):
         # Let Pydantic/internal stuff pass silently ! fragile
         if name.startswith("__"):
@@ -100,6 +100,11 @@ class ApiErrorIdentifier(StrEnum):
     UNKNOWN_ERROR = "unknown_error_occurred"
     URL_NOT_FOUND = "requested_resource_not_found"
 
+    @property
+    def get_error_code(self) -> str:
+        """Get the corresponding ApiError."""
+        return ApiError[self.value]
+
 
 class ApiErrorLevel(StrEnum):
     """API error levels"""

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/common/scopes.py

@@ -6,6 +6,7 @@ logger = logging.getLogger("uvicorn")
 
 class Fallback(EnumMeta):
     """Fallback to no scope for unknown scopes."""
+
     # Note: This is a workaround to avoid the AttributeError when an unknown scope is accessed.
     # As soon as we have stable scopes, we can remove this.
 
@@ -19,7 +20,7 @@ class Fallback(EnumMeta):
         return None
 
 
-class Scope(StrEnum, metaclass=Fallback):
+class Scope(StrEnum):
     """
     The permission scopes for the API.
     """

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/common/utils.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Union
 from decimal import Decimal
 import string
 import random
@@ -9,19 +9,19 @@ from fastapi import status
 from crypticorn.common import ApiError
 
 
-def throw_if_none(value: Any, message: ApiError) -> None:
+def throw_if_none(value: Any, message: Union[ApiError, str]) -> None:
     """Throws an FastAPI HTTPException if the value is None."""
     if value is None:
         raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND, detail=message.identifier
+            status_code=status.HTTP_404_NOT_FOUND, detail=message.identifier if isinstance(message, ApiError) else message
         )
 
 
-def throw_if_falsy(value: Any, message: ApiError) -> None:
+def throw_if_falsy(value: Any, message: Union[ApiError, str]) -> None:
     """Throws an FastAPI HTTPException if the value is False."""
     if not value:
         raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST, detail=message.identifier
+            status_code=status.HTTP_400_BAD_REQUEST, detail=message.identifier if isinstance(message, ApiError) else message
         )
 
 
@@ -50,3 +50,13 @@ def is_equal(
     return Decimal(abs(a - b)) <= max(
         Decimal(str(rel_tol)) * max(abs(a), abs(b)), Decimal(str(abs_tol))
     )
+
+def optional_import(module_name: str, extra_name: str):
+    try:
+        return __import__(module_name)
+    except ImportError as e:
+        extra = f"[{extra_name}]"
+        raise ImportError(
+            f"Optional dependency '{module_name}' is required for this feature. "
+            f"Install it with: pip install crypticorn{extra}"
+        ) from e

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/klines/main.py

@@ -1,4 +1,4 @@
-import pandas as pd
+from __future__ import annotations
 from crypticorn.klines import (
     ApiClient,
     Configuration,
@@ -8,6 +8,7 @@ from crypticorn.klines import (
     SymbolsApi,
     UDFApi,
 )
+from crypticorn.common import optional_import
 
 
 class FundingRatesApiWrapper(FundingRatesApi):
@@ -15,7 +16,8 @@ class FundingRatesApiWrapper(FundingRatesApi):
     A wrapper for the FundingRatesApi class.
     """
 
-    def get_funding_rates_fmt(self):
+    def get_funding_rates_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.funding_rate_funding_rates_symbol_get()
         return pd.DataFrame(response.json())
 
@@ -25,7 +27,8 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
     A wrapper for the OHLCVDataApi class.
     """
 
-    def get_ohlcv_data_fmt(self):
+    def get_ohlcv_data_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.get_ohlcv_market_timeframe_symbol_get()
         return pd.DataFrame(response.json())
 
@@ -35,7 +38,8 @@ class SymbolsApiWrapper(SymbolsApi):
     A wrapper for the SymbolsApi class.
     """
 
-    def get_symbols_fmt(self):
+    def get_symbols_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.symbols_symbols_market_get()
         return pd.DataFrame(response.json())
 
@@ -45,7 +49,8 @@ class UDFApiWrapper(UDFApi):
     A wrapper for the UDFApi class.
     """
 
-    def get_udf_fmt(self):
+    def get_udf_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.get_history_udf_history_get()
         return pd.DataFrame(response.json())
 

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/metrics/client/models/exchange_mapping.py

@@ -20,6 +20,8 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from crypticorn.metrics.client.models.market_type import MarketType
+from crypticorn.metrics.client.models.trading_status import TradingStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -35,8 +37,8 @@ class ExchangeMapping(BaseModel):
     pair: StrictStr
     first_trade_timestamp: Optional[datetime]
     last_trade_timestamp: Optional[datetime]
-    status: StrictStr
-    market_type: Optional[StrictStr]
+    status: TradingStatus
+    market_type: Optional[MarketType]
     __properties: ClassVar[List[str]] = [
         "exchange_name",
         "symbol",

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/metrics/client/models/trading_status.py

@@ -28,6 +28,7 @@ class TradingStatus(str, Enum):
     """
     ACTIVE = "ACTIVE"
     RETIRED = "RETIRED"
+    EXPIRED = "EXPIRED"
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/metrics/main.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from crypticorn.metrics import (
     ApiClient,
     Configuration,
@@ -10,13 +11,11 @@ from crypticorn.metrics import (
     TokensApi,
     MarketType,
 )
+from crypticorn.common import optional_import
 from pydantic import StrictStr, StrictInt, Field
 from typing_extensions import Annotated
 from typing import Optional
 
-import pandas as pd
-
-
 class MetricsClient:
     """
     A client for interacting with the Crypticorn Metrics API.
@@ -67,7 +66,8 @@ class MarketcapApiWrapper(MarketcapApi):
         """
         Get the marketcap symbols in a pandas dataframe
         """
-        response = await self.get_marketcap_symbols_without_preload_content(
+        pd = optional_import("pandas", "extra")
+        response = await self.get_marketcap_symbols(
             start_timestamp=start_timestamp,
             end_timestamp=end_timestamp,
             interval=interval,
@@ -96,6 +96,7 @@ class TokensApiWrapper(TokensApi):
         """
         Get the tokens in a pandas dataframe
         """
+        pd = optional_import("pandas", "extra")
         response = await self.get_stable_and_wrapped_tokens_without_preload_content(
             token_type=token_type
         )

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/pay/client/__init__.py

@@ -41,13 +41,14 @@ 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.payment import Payment
 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
-from crypticorn.pay.client.models.product_update_model import ProductUpdateModel
+from crypticorn.pay.client.models.product_create import ProductCreate
+from crypticorn.pay.client.models.product_read import ProductRead
+from crypticorn.pay.client.models.product_sub_read import ProductSubRead
+from crypticorn.pay.client.models.product_update import ProductUpdate
 from crypticorn.pay.client.models.scope import Scope
 from crypticorn.pay.client.models.services import Services
-from crypticorn.pay.client.models.unified_payment_model import UnifiedPaymentModel
 from crypticorn.pay.client.models.validation_error import ValidationError
 from crypticorn.pay.client.models.validation_error_loc_inner import (
     ValidationErrorLocInner,

{crypticorn-2.4.5 → crypticorn-2.4.7}/crypticorn/pay/client/api/payments_api.py

@@ -19,8 +19,8 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictInt, 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
+from crypticorn.pay.client.models.payment import Payment
+from crypticorn.pay.client.models.product_sub_read import ProductSubRead
 
 from crypticorn.pay.client.api_client import ApiClient, RequestSerialized
 from crypticorn.pay.client.api_response import ApiResponse
@@ -57,7 +57,7 @@ class PaymentsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> UnifiedPaymentModel:
+    ) -> Payment:
         """Get Latest Payment From Invoice
 
         Get the latest payment by a user from an invoice
@@ -95,7 +95,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "UnifiedPaymentModel",
+            "200": "Payment",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -125,7 +125,7 @@ class PaymentsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[UnifiedPaymentModel]:
+    ) -> ApiResponse[Payment]:
         """Get Latest Payment From Invoice
 
         Get the latest payment by a user from an invoice
@@ -163,7 +163,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "UnifiedPaymentModel",
+            "200": "Payment",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -231,7 +231,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "UnifiedPaymentModel",
+            "200": "Payment",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -321,7 +321,7 @@ class PaymentsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[UnifiedPaymentModel]:
+    ) -> List[Payment]:
         """Get Payments
 
         Get the combined payment history for a user across all payment services.
@@ -362,7 +362,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[UnifiedPaymentModel]",
+            "200": "List[Payment]",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -400,7 +400,7 @@ class PaymentsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[UnifiedPaymentModel]]:
+    ) -> ApiResponse[List[Payment]]:
         """Get Payments
 
         Get the combined payment history for a user across all payment services.
@@ -441,7 +441,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[UnifiedPaymentModel]",
+            "200": "List[Payment]",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -520,7 +520,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[UnifiedPaymentModel]",
+            "200": "List[Payment]",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -609,7 +609,7 @@ class PaymentsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[ProductSubsModel]:
+    ) -> List[ProductSubRead]:
         """Get Subscriptions
 
         Get all subscriptions for a user. Subscriptions are the products a user has subscribed to. Returns both active and inactive subscriptions.
@@ -647,7 +647,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[ProductSubsModel]",
+            "200": "List[ProductSubRead]",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -679,7 +679,7 @@ class PaymentsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[ProductSubsModel]]:
+    ) -> ApiResponse[List[ProductSubRead]]:
         """Get Subscriptions
 
         Get all subscriptions for a user. Subscriptions are the products a user has subscribed to. Returns both active and inactive subscriptions.
@@ -717,7 +717,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[ProductSubsModel]",
+            "200": "List[ProductSubRead]",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(
@@ -787,7 +787,7 @@ class PaymentsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            "200": "List[ProductSubsModel]",
+            "200": "List[ProductSubRead]",
             "422": "HTTPValidationError",
         }
         response_data = await self.api_client.call_api(