crypticorn 2.6.0__tar.gz → 2.7.1__tar.gz

{crypticorn-2.6.0 → crypticorn-2.7.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.6.0
-Summary: Maximise Your Crypto Trading Profits with AI Predictions
+Version: 2.7.1
+Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
 Keywords: machine learning,data science,crypto,modelling

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/common/errors.py

@@ -60,6 +60,7 @@ class ApiErrorIdentifier(ExcludeEnumMixin, StrEnum):
     INVALID_PARAMETER = "invalid_parameter_provided"
     LEVERAGE_EXCEEDED = "leverage_limit_exceeded"
     LIQUIDATION_PRICE_VIOLATION = "order_violates_liquidation_price_constraints"
+    MODEL_NAME_NOT_UNIQUE = "model_name_not_unique"
     NO_CREDENTIALS = "no_credentials"
     NOW_API_DOWN = "now_api_down"
     OBJECT_ALREADY_EXISTS = "object_already_exists"
@@ -318,6 +319,11 @@ class ApiError(ExcludeEnumMixin, Enum, metaclass=ApiErrorFallback):
         ApiErrorType.SERVER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    MODEL_NAME_NOT_UNIQUE = (
+        ApiErrorIdentifier.MODEL_NAME_NOT_UNIQUE,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     NO_CREDENTIALS = (
         ApiErrorIdentifier.NO_CREDENTIALS,
         ApiErrorType.USER_ERROR,
@@ -598,6 +604,10 @@ class StatusCodeMapper:
             status.HTTP_409_CONFLICT,
             status.WS_1008_POLICY_VIOLATION,
         ),
+        ApiError.MODEL_NAME_NOT_UNIQUE: (
+            status.HTTP_409_CONFLICT,
+            status.WS_1008_POLICY_VIOLATION,
+        ),
         # Invalid Content
         ApiError.CONTENT_TYPE_ERROR: (
             status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/api/data_api.py

@@ -48,9 +48,10 @@ class DataApi:
         version: Annotated[
             Optional[DataVersion],
             Field(description="Data version. Default is the latest public version."),
-        ],
+        ] = None,
         feature_size: Annotated[
-            Optional[FeatureSize], Field(description="Feature size")
+            Optional[FeatureSize],
+            Field(description="The number of features in the data. Default is LARGE."),
         ] = None,
         _request_timeout: Union[
             None,
@@ -70,9 +71,9 @@ class DataApi:
 
         :param model_id: Model ID (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version. (required)
+        :param version: Data version. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: Feature size
+        :param feature_size: The number of features in the data. Default is LARGE.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -125,9 +126,10 @@ class DataApi:
         version: Annotated[
             Optional[DataVersion],
             Field(description="Data version. Default is the latest public version."),
-        ],
+        ] = None,
         feature_size: Annotated[
-            Optional[FeatureSize], Field(description="Feature size")
+            Optional[FeatureSize],
+            Field(description="The number of features in the data. Default is LARGE."),
         ] = None,
         _request_timeout: Union[
             None,
@@ -147,9 +149,9 @@ class DataApi:
 
         :param model_id: Model ID (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version. (required)
+        :param version: Data version. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: Feature size
+        :param feature_size: The number of features in the data. Default is LARGE.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -202,9 +204,10 @@ class DataApi:
         version: Annotated[
             Optional[DataVersion],
             Field(description="Data version. Default is the latest public version."),
-        ],
+        ] = None,
         feature_size: Annotated[
-            Optional[FeatureSize], Field(description="Feature size")
+            Optional[FeatureSize],
+            Field(description="The number of features in the data. Default is LARGE."),
         ] = None,
         _request_timeout: Union[
             None,
@@ -224,9 +227,9 @@ class DataApi:
 
         :param model_id: Model ID (required)
         :type model_id: int
-        :param version: Data version. Default is the latest public version. (required)
+        :param version: Data version. Default is the latest public version.
         :type version: DataVersion
-        :param feature_size: Feature size
+        :param feature_size: The number of features in the data. Default is LARGE.
         :type feature_size: FeatureSize
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/coins.py

@@ -20,7 +20,7 @@ from typing_extensions import Self
 
 class Coins(str, Enum):
     """
-    All ever existing coins
+    All existing coins. Some might no be available in the latest data version, but kept for older versions.
     """
 
     """

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/data_download_response.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from crypticorn.hive.client.models.coins import Coins
 from crypticorn.hive.client.models.data_version import DataVersion
@@ -30,13 +30,13 @@ from typing_extensions import Self
 
 class DataDownloadResponse(BaseModel):
     """
-    DataDownloadResponse
+    The response for a data download request
     """  # noqa: E501
 
-    coin: Coins
-    feature_size: FeatureSize
-    version: DataVersion
-    target: Target
+    coin: Coins = Field(description="The coin the data is for")
+    feature_size: FeatureSize = Field(description="The feature size the data is for")
+    version: DataVersion = Field(description="The version of the data")
+    target: Target = Field(description="The target of the data")
     links: DownloadLinks
     __properties: ClassVar[List[str]] = [
         "coin",

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/data_info.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from crypticorn.hive.client.models.coins import Coins
 from crypticorn.hive.client.models.data_value_value_value_inner import (
@@ -32,15 +32,27 @@ from typing_extensions import Self
 
 class DataInfo(BaseModel):
     """
-    DataInfo
+    The complete data information for all versions, coins, feature sizes and targets
     """  # noqa: E501
 
-    data: Dict[str, Dict[str, Dict[str, List[DataValueValueValueInner]]]]
-    coins: List[Coins]
-    feature_sizes: List[FeatureSize]
-    targets: List[TargetInfo]
-    all_versions: List[DataVersionInfo]
-    available_versions: List[DataVersionInfo]
+    data: Dict[str, Dict[str, Dict[str, List[DataValueValueValueInner]]]] = Field(
+        description="The complete data information for all versions, coins, feature sizes and targets."
+    )
+    coins: List[Coins] = Field(
+        description="The coins available on the latest data version."
+    )
+    feature_sizes: List[FeatureSize] = Field(
+        description="The feature sizes available on the latest data version."
+    )
+    targets: List[TargetInfo] = Field(
+        description="The targets available on the latest data version."
+    )
+    all_versions: List[DataVersionInfo] = Field(
+        description="All ever existing data versions. Some may not be publicly available yet."
+    )
+    available_versions: List[DataVersionInfo] = Field(
+        description="All publicly available data versions."
+    )
     __properties: ClassVar[List[str]] = [
         "data",
         "coins",

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/data_version.py

@@ -20,7 +20,7 @@ from typing_extensions import Self
 
 class DataVersion(str, Enum):
     """
-    All ever existing data versions
+    All existing data versions
     """
 
     """

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/download_links.py

@@ -25,12 +25,16 @@ from typing_extensions import Self
 
 class DownloadLinks(BaseModel):
     """
-    DownloadLinks
+    The download links for the data
     """  # noqa: E501
 
-    y_train: StrictStr
-    x_test: StrictStr = Field(alias="X_test")
-    x_train: StrictStr = Field(alias="X_train")
+    y_train: StrictStr = Field(description="The download link for the y_train data")
+    x_test: StrictStr = Field(
+        description="The download link for the X_test data", alias="X_test"
+    )
+    x_train: StrictStr = Field(
+        description="The download link for the X_train data", alias="X_train"
+    )
     __properties: ClassVar[List[str]] = ["y_train", "X_test", "X_train"]
 
     model_config = ConfigDict(

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/feature_size.py

@@ -20,7 +20,7 @@ from typing_extensions import Self
 
 class FeatureSize(str, Enum):
     """
-    All ever existing feature sizes
+    All existing feature sizes. Some might no be available in the latest data version, but kept for older versions.
     """
 
     """

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/target.py

@@ -20,7 +20,7 @@ from typing_extensions import Self
 
 class Target(str, Enum):
     """
-    All ever existing targets
+    All existing targets. Some might no be available in the latest data version, but kept for older versions.
     """
 
     """

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/target_info.py

@@ -28,7 +28,7 @@ from typing_extensions import Self
 
 class TargetInfo(BaseModel):
     """
-    TargetInfo
+    Information about a target
     """  # noqa: E501
 
     name: Target = Field(description="Target name")

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/hive/client/models/target_type.py

@@ -20,7 +20,7 @@ from typing_extensions import Self
 
 class TargetType(str, Enum):
     """
-    TargetType
+    The type of the target
     """
 
     """

crypticorn-2.7.1/crypticorn/hive/main.py

@@ -0,0 +1,75 @@
+import asyncio
+from pathlib import Path
+import os
+from crypticorn.hive import (
+    ApiClient,
+    Configuration,
+    ModelsApi,
+    DataApi,
+    StatusApi,
+    Configuration,
+)
+from crypticorn.hive.utils import download_file
+import logging
+
+
+class DataApiWrapper(DataApi):
+    """
+    A wrapper for the DataApi class.
+    """
+
+    async def download_data(self, folder: Path = "data", *args, **kwargs) -> list[Path]:
+        """
+        Download data for model training. All three files (y_train, x_test, x_train) are downloaded and saved under e.g. FOLDER/v1/coin_1/*.feather.
+        The folder will be created if it doesn't exist.
+
+        :param model_id: Model ID (required) (type: int)
+        :param version: Data version. Default is the latest public version. (optional) (type: DataVersion)
+        :param feature_size: The number of features in the data. Default is LARGE. (optional) (type: FeatureSize)
+        :return: A list of paths to the downloaded files.
+        """
+        response = await super().download_data(*args, **kwargs)
+        base_path = f"{folder}/v{response.version.value}/coin_{response.coin.value}/"
+        os.makedirs(base_path, exist_ok=True)
+
+        return await asyncio.gather(
+            *[
+                download_file(
+                    url=response.links.y_train,
+                    dest_path=base_path + "y_train_" + response.target + ".feather",
+                ),
+                download_file(
+                    url=response.links.x_test,
+                    dest_path=base_path
+                    + "x_test_"
+                    + response.feature_size
+                    + ".feather",
+                ),
+                download_file(
+                    url=response.links.x_train,
+                    dest_path=base_path
+                    + "x_train_"
+                    + response.feature_size
+                    + ".feather",
+                ),
+            ]
+        )
+
+
+class HiveClient:
+    """
+    A client for interacting with the Crypticorn Hive API.
+    """
+
+    config_class = Configuration
+
+    def __init__(
+        self,
+        config: Configuration,
+    ):
+        self.config = config
+        self.base_client = ApiClient(configuration=self.config)
+        # Instantiate all the endpoint clients
+        self.models = ModelsApi(self.base_client)
+        self.data = DataApiWrapper(self.base_client)
+        self.status = StatusApi(self.base_client)

crypticorn-2.7.1/crypticorn/hive/utils.py

@@ -0,0 +1,67 @@
+import requests
+import os
+import tqdm
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
+
+async def download_file(
+    url: str, dest_path: str, show_progress_bars: bool = True
+) -> str:
+    """downloads a file and shows a progress bar. allow resuming a download"""
+    file_size = 0
+    req = requests.get(url, stream=True, timeout=600)
+    req.raise_for_status()
+
+    total_size = int(req.headers.get("content-length", 0))
+    temp_path = dest_path + ".temp"
+
+    if os.path.exists(dest_path):
+        logger.info(f" file already exists: {dest_path}")
+        file_size = os.stat(dest_path).st_size
+        if file_size == total_size:
+            return dest_path
+
+    if os.path.exists(temp_path):
+        file_size = os.stat(temp_path).st_size
+
+        if file_size < total_size:
+            # Download incomplete
+            logger.info(f" resuming download")
+            resume_header = {"Range": f"bytes={file_size}-"}
+            req = requests.get(
+                url,
+                headers=resume_header,
+                stream=True,
+                verify=False,
+                allow_redirects=True,
+                timeout=600,
+            )
+        else:
+            # Error, delete file and restart download
+            logger.error(f" deleting file {dest_path} and restarting")
+            os.remove(temp_path)
+            file_size = 0
+    else:
+        # File does not exist, starting download
+        logger.info(f" starting download")
+
+    # write dataset to file and show progress bar
+    pbar = tqdm.tqdm(
+        total=total_size,
+        unit="B",
+        unit_scale=True,
+        desc=dest_path,
+        disable=not show_progress_bars,
+    )
+    # Update progress bar to reflect how much of the file is already downloaded
+    pbar.update(file_size)
+    with open(temp_path, "ab") as dest_file:
+        for chunk in req.iter_content(1024):
+            dest_file.write(chunk)
+            pbar.update(1024)
+    # move temp file to target destination
+    os.replace(temp_path, dest_path)
+    return dest_path

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/klines/main.py

@@ -10,6 +10,25 @@ from crypticorn.klines import (
 )
 from crypticorn.common import optional_import
 
+class KlinesClient:
+    """
+    A client for interacting with the Crypticorn Klines API.
+    """
+
+    config_class = Configuration
+
+    def __init__(
+        self,
+        config: Configuration,
+    ):
+        self.config = config
+        self.base_client = ApiClient(configuration=self.config)
+        # Instantiate all the endpoint clients
+        self.funding = FundingRatesApiWrapper(self.base_client)
+        self.ohlcv = OHLCVDataApiWrapper(self.base_client)
+        self.symbols = SymbolsApiWrapper(self.base_client)
+        self.udf = UDFApi(self.base_client)
+        self.status = StatusApi(self.base_client)
 
 class FundingRatesApiWrapper(FundingRatesApi):
     """
@@ -21,11 +40,16 @@ class FundingRatesApiWrapper(FundingRatesApi):
         Get the funding rates in a pandas DataFrame.
         """
         pd = optional_import("pandas", "extra")
-        response = await self.get_funding_rates_without_preload_content(*args, **kwargs)
-        response.raise_for_status()
-        json_data = await response.json()
-        return pd.DataFrame(json_data)
-
+        response = await self.get_funding_rates(*args, **kwargs)
+        response = [
+            {
+                "timestamp": int(m.timestamp.timestamp()),
+                "symbol": m.symbol,
+                "funding_rate": m.funding_rate,
+            }
+            for m in response
+        ]
+        return pd.DataFrame(response)
 
 class OHLCVDataApiWrapper(OHLCVDataApi):
     """
@@ -37,19 +61,20 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
         Get the OHLCV data in a pandas DataFrame.
         """
         pd = optional_import("pandas", "extra")
-        response = await self.get_ohlcv_without_preload_content(*args, **kwargs)
-        response.raise_for_status()
-        json_data = await response.json()
-        return pd.DataFrame(
+        response = await self.get_ohlcv(*args, **kwargs)
+        df = pd.DataFrame(
             {
-                "timestamp": json_data["timestamp"],
-                "open": json_data["open"],
-                "high": json_data["high"],
-                "low": json_data["low"],
-                "close": json_data["close"],
-                "volume": json_data["volume"],
+                "timestamp": [int(d.timestamp()) for d in response.timestamps],
+                "open": response.open,
+                "high": response.high,
+                "low": response.low,
+                "close": response.close,
+                "volume": response.volume,
             }
         )
+        df.sort_values(by="timestamp", ascending=False, inplace=True)
+        df.reset_index(drop=True, inplace=True)
+        return df
 
 
 class SymbolsApiWrapper(SymbolsApi):
@@ -62,30 +87,7 @@ class SymbolsApiWrapper(SymbolsApi):
         Get the symbols in a pandas DataFrame.
         """
         pd = optional_import("pandas", "extra")
-        response = await self.get_klines_symbols_without_preload_content(
-            *args, **kwargs
-        )
-        response.raise_for_status()
-        json_data = await response.json()
-        return pd.DataFrame(json_data["data"], columns=["symbol"])
+        response = await self.get_klines_symbols(*args, **kwargs)
+        return pd.DataFrame(response, columns=["symbol"])
 
 
-class KlinesClient:
-    """
-    A client for interacting with the Crypticorn Klines API.
-    """
-
-    config_class = Configuration
-
-    def __init__(
-        self,
-        config: Configuration,
-    ):
-        self.config = config
-        self.base_client = ApiClient(configuration=self.config)
-        # Instantiate all the endpoint clients
-        self.funding = FundingRatesApiWrapper(self.base_client)
-        self.ohlcv = OHLCVDataApiWrapper(self.base_client)
-        self.symbols = SymbolsApiWrapper(self.base_client)
-        self.udf = UDFApi(self.base_client)
-        self.status = StatusApi(self.base_client)

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn/metrics/main.py

@@ -33,7 +33,7 @@ class MetricsClient:
         self.marketcap = MarketcapApiWrapper(self.base_client)
         self.markets = MarketsApi(self.base_client)
         self.tokens = TokensApiWrapper(self.base_client)
-        self.exchanges = ExchangesApi(self.base_client)
+        self.exchanges = ExchangesApiWrapper(self.base_client)
 
 
 class MarketcapApiWrapper(MarketcapApi):
@@ -46,12 +46,8 @@ class MarketcapApiWrapper(MarketcapApi):
         Get the marketcap symbols in a pandas dataframe
         """
         pd = optional_import("pandas", "extra")
-        response = await self.get_marketcap_symbols_without_preload_content(
-            *args, **kwargs
-        )
-        response.raise_for_status()
-        json_response = await response.json()
-        df = pd.DataFrame(json_response["data"])
+        response = await self.get_marketcap_symbols(*args, **kwargs)
+        df = pd.DataFrame(response)
         df.rename(columns={df.columns[0]: "timestamp"}, inplace=True)
         return df
 
@@ -66,12 +62,8 @@ 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(
-            *args, **kwargs
-        )
-        response.raise_for_status()
-        json_data = await response.json()
-        return pd.DataFrame(json_data)
+        response = await self.get_stable_and_wrapped_tokens(*args, **kwargs)
+        return pd.DataFrame(response)
 
 
 class ExchangesApiWrapper(ExchangesApi):
@@ -79,18 +71,14 @@ class ExchangesApiWrapper(ExchangesApi):
     A wrapper for the ExchangesApi class.
     """
 
-    async def get_exchanges_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
+    async def get_available_exchanges_fmt(self, *args, **kwargs) -> pd.DataFrame:  # type: ignore
         """
         Get the exchanges in a pandas dataframe
         """
         pd = optional_import("pandas", "extra")
-        response = await self.get_available_exchanges_without_preload_content(
-            *args, **kwargs
-        )
-        response.raise_for_status()
-        json_data = await response.json()
+        response = await self.get_available_exchanges(*args, **kwargs)
         processed_results = []
-        for row in json_data:
+        for row in response:
             data = {"timestamp": row["timestamp"]}
             data.update(row["exchanges"])
             processed_results.append(data)

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.6.0
-Summary: Maximise Your Crypto Trading Profits with AI Predictions
+Version: 2.7.1
+Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
 Keywords: machine learning,data science,crypto,modelling

{crypticorn-2.6.0 → crypticorn-2.7.1}/crypticorn.egg-info/SOURCES.txt

@@ -82,6 +82,7 @@ crypticorn/common/urls.py
 crypticorn/common/utils.py
 crypticorn/hive/__init__.py
 crypticorn/hive/main.py
+crypticorn/hive/utils.py
 crypticorn/hive/client/__init__.py
 crypticorn/hive/client/api_client.py
 crypticorn/hive/client/api_response.py

{crypticorn-2.6.0 → crypticorn-2.7.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "crypticorn"
-description = "Maximise Your Crypto Trading Profits with AI Predictions"
+description = "Maximise Your Crypto Trading Profits with Machine Learning"
 readme = "README.md"
 requires-python = ">=3.10"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.6.0"
+version = "2.7.1"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]
 

crypticorn-2.6.0/crypticorn/hive/main.py

@@ -1,28 +0,0 @@
-from crypticorn.hive import (
-    ApiClient,
-    Configuration,
-    ModelsApi,
-    DataApi,
-    StatusApi,
-    Configuration,
-)
-from crypticorn.common import apikey_header as aph
-
-
-class HiveClient:
-    """
-    A client for interacting with the Crypticorn Hive API.
-    """
-
-    config_class = Configuration
-
-    def __init__(
-        self,
-        config: Configuration,
-    ):
-        self.config = config
-        self.base_client = ApiClient(configuration=self.config)
-        # Instantiate all the endpoint clients
-        self.models = ModelsApi(self.base_client)
-        self.data = DataApi(self.base_client)
-        self.status = StatusApi(self.base_client)