crypticorn 1.0.2rc3__py3-none-any.whl → 2.0.0__py3-none-any.whl

crypticorn/hive/main.py

@@ -1,107 +1,34 @@
-from typing import Any
-import pandas as pd
-import requests
-import os
-from crypticorn.hive.utils import download_file, SingleModel, ModelEvaluation, DataInfo
+from crypticorn.hive import (
+    ApiClient,
+    Configuration,
+    ModelsApi,
+    DataApi,
+    StatusApi,
+)
+from crypticorn.common import BaseURL, ApiVersion, Service, apikey_header as aph
 
 
 class HiveClient:
     """
-    A client for interacting with the Crypticorn Hive API, offering functionality to create and evaluate models,
-    download data, and retrieve information about available coins, targets, and features.
+    A client for interacting with the Crypticorn Hive API.
     """
 
-    def __init__(self, base_url='https://api.crypticorn.com', api_key: str = None, jwt: str = None):
-        """@private
-        Initializes the Crypticorn Hive API client with an API key.
-
-        :param api_key: The API key required for authenticating requests.
-        """
-        self._base_url = base_url + "/v1/hive"
-        self._headers = {"Authorization": f"ApiKey {api_key}"}
-
-    def create_model(self, coin_id: int, target: str) -> SingleModel:
-        """
-        Creates a new model based on the specified coin_id and target.
-
-        :param coin_id: The id of the coin to be used for the model.
-        :param target: The target variable for the model.
-        """
-        endpoint = "/model/creation"
-        response = requests.post(
-            url=self._base_url + endpoint,
-            params={"coin_id": coin_id, "target": target},
-            headers=self._headers
+    def __init__(
+        self,
+        base_url: BaseURL,
+        api_version: ApiVersion,
+        api_key: str = None,
+        jwt: str = None,
+    ):
+        self.host = f"{base_url.value}/{api_version.value}/{Service.HIVE.value}"
+        self.config = Configuration(
+            host=self.host,
+            access_token=jwt,
+            api_key={aph.scheme_name: api_key} if api_key else None,
+            api_key_prefix=({aph.scheme_name: aph.model.name} if api_key else None),
         )
-        return response.json()
-
-    def evaluate_model(self, model_id: int, data: Any, version: float = None) -> ModelEvaluation:
-        """
-        Evaluates an existing model using the provided data.
-
-        :param model_id: The id of the model to evaluate.
-        :param data: The data to use for evaluation, which can be a pandas DataFrame or a file path with
-                 extensions `.feather` or `.parquet`.
-        :param version: (optional) Specifies the data version for evaluation. Defaults to the latest version.
-                If a different version than the latest is specified, the evaluation will not be stored
-                or counted on the leaderboard. This is useful for testing your model with different versions.
-                Ensure to specify a `version` if your model was trained on older data versions; otherwise,
-                it will be evaluated against the latest data, potentially affecting the results.
-        """
-        if isinstance(data, pd.DataFrame):
-            json_data = data.to_json(orient='records')
-        elif isinstance(data, str):
-            if data.endswith('.feather'):
-                json_data = pd.read_feather(data).to_json(orient="records")
-            elif data.endswith('.parquet'):
-                json_data = pd.read_parquet(data).to_json(orient="records")
-            else:
-                raise ValueError("Unsupported file format. Use .feather, .parquet, or pd.Dataframe.")
-        else:
-            raise ValueError("Unsupported data format. Pass a pd.DataFrame or a valid file path.")
-
-        endpoint = "/model/evaluation"
-        response = requests.post(
-            url=self._base_url + endpoint,
-            params={"model_id": model_id, "version": version},
-            json=json_data,
-            headers=self._headers
-        )
-        return response.json()
-
-    def download_data(self, model_id: int, version: float = None,
-                      feature_size: str = None) -> int:
-        """
-        Downloads training data for models.
-        Either pass a model_id or coin_id. For more details about available data, use `data_info()`.
-
-        :param model_id: id of the model to download data for.
-        :param version: (optional) Data version to download. Defaults to the latest version if not specified.
-        :param feature_size: (optional) Size of the feature set to download. Default is "large".
-        """
-        endpoint = "/data"
-        response = requests.get(
-            url=self._base_url + endpoint,
-            params={"feature_size": feature_size, "version": version, "model_id": model_id},
-            headers=self._headers
-        )
-        if response.status_code != 200:
-            return response.json()
-        data = response.json()
-        base_path = f"v{data['version']}/coin_{data['coin']}/"
-        os.makedirs(base_path, exist_ok=True)
-        download_file(url=data["y_train"], dest_path=f"{base_path}y_train_{data['target']}.feather")
-        download_file(url=data["X_test"], dest_path=f"{base_path}X_test_{data['feature_size']}.feather")
-        download_file(url=data["X_train"], dest_path=f"{base_path}X_train_{data['feature_size']}.feather")
-        return 200
-
-    def data_info(self) -> DataInfo:
-        """
-        Returns information about the training data.
-        Useful in combination with `download_data()` and `create_model()`.
-        """
-        endpoint = "/data/info"
-        response = requests.get(
-            url=self._base_url + endpoint,
-            headers=self._headers)
-        return response.json()
+        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)

crypticorn/klines/client/__init__.py

@@ -35,22 +35,34 @@ from crypticorn.klines.client.exceptions import ApiAttributeError
 from crypticorn.klines.client.exceptions import ApiException
 
 # import models into sdk package
-from crypticorn.klines.client.models.base_response_health_check_response import BaseResponseHealthCheckResponse
-from crypticorn.klines.client.models.base_response_list_funding_rate_response import BaseResponseListFundingRateResponse
+from crypticorn.klines.client.models.base_response_health_check_response import (
+    BaseResponseHealthCheckResponse,
+)
+from crypticorn.klines.client.models.base_response_list_funding_rate_response import (
+    BaseResponseListFundingRateResponse,
+)
 from crypticorn.klines.client.models.base_response_list_str import BaseResponseListStr
-from crypticorn.klines.client.models.base_response_ohlcv_response import BaseResponseOHLCVResponse
+from crypticorn.klines.client.models.base_response_ohlcv_response import (
+    BaseResponseOHLCVResponse,
+)
 from crypticorn.klines.client.models.error_response import ErrorResponse
 from crypticorn.klines.client.models.exchange import Exchange
 from crypticorn.klines.client.models.funding_rate_response import FundingRateResponse
 from crypticorn.klines.client.models.http_validation_error import HTTPValidationError
 from crypticorn.klines.client.models.health_check_response import HealthCheckResponse
 from crypticorn.klines.client.models.history_error_response import HistoryErrorResponse
-from crypticorn.klines.client.models.history_no_data_response import HistoryNoDataResponse
-from crypticorn.klines.client.models.history_success_response import HistorySuccessResponse
+from crypticorn.klines.client.models.history_no_data_response import (
+    HistoryNoDataResponse,
+)
+from crypticorn.klines.client.models.history_success_response import (
+    HistorySuccessResponse,
+)
 from crypticorn.klines.client.models.market import Market
 from crypticorn.klines.client.models.ohlcv_response import OHLCVResponse
 from crypticorn.klines.client.models.resolution import Resolution
-from crypticorn.klines.client.models.response_get_history_udf_history_get import ResponseGetHistoryUdfHistoryGet
+from crypticorn.klines.client.models.response_get_history_udf_history_get import (
+    ResponseGetHistoryUdfHistoryGet,
+)
 from crypticorn.klines.client.models.search_symbol_response import SearchSymbolResponse
 from crypticorn.klines.client.models.sort_direction import SortDirection
 from crypticorn.klines.client.models.symbol_group_response import SymbolGroupResponse
@@ -59,4 +71,6 @@ from crypticorn.klines.client.models.symbol_type import SymbolType
 from crypticorn.klines.client.models.timeframe import Timeframe
 from crypticorn.klines.client.models.udf_config_response import UDFConfigResponse
 from crypticorn.klines.client.models.validation_error import ValidationError
-from crypticorn.klines.client.models.validation_error_loc_inner import ValidationErrorLocInner
+from crypticorn.klines.client.models.validation_error_loc_inner import (
+    ValidationErrorLocInner,
+)

crypticorn/klines/client/api/__init__.py

@@ -6,4 +6,3 @@ from crypticorn.klines.client.api.health_check_api import HealthCheckApi
 from crypticorn.klines.client.api.ohlcv_data_api import OHLCVDataApi
 from crypticorn.klines.client.api.symbols_api import SymbolsApi
 from crypticorn.klines.client.api.udf_api import UDFApi
-

crypticorn/klines/client/api/funding_rates_api.py

@@ -19,7 +19,9 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictInt, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
-from crypticorn.klines.client.models.base_response_list_funding_rate_response import BaseResponseListFundingRateResponse
+from crypticorn.klines.client.models.base_response_list_funding_rate_response import (
+    BaseResponseListFundingRateResponse,
+)
 
 from crypticorn.klines.client.api_client import ApiClient, RequestSerialized
 from crypticorn.klines.client.api_response import ApiResponse
@@ -38,21 +40,28 @@ class FundingRatesApi:
             api_client = ApiClient.get_default()
         self.api_client = api_client
 
-
     @validate_call
     def funding_rate_funding_rates_symbol_get(
         self,
-        symbol: Annotated[StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")],
-        start: Annotated[Optional[StrictInt], Field(description="Start timestamp in milliseconds")] = None,
-        end: Annotated[Optional[StrictInt], Field(description="End timestamp in milliseconds")] = None,
-        limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Number of funding rates to return")] = None,
+        symbol: Annotated[
+            StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")
+        ],
+        start: Annotated[
+            Optional[StrictInt], Field(description="Start timestamp in milliseconds")
+        ] = None,
+        end: Annotated[
+            Optional[StrictInt], Field(description="End timestamp in milliseconds")
+        ] = None,
+        limit: Annotated[
+            Optional[Annotated[int, Field(strict=True, ge=1)]],
+            Field(description="Number of funding rates to return"),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
             Tuple[
-                Annotated[StrictFloat, Field(gt=0)],
-                Annotated[StrictFloat, Field(gt=0)]
-            ]
+                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
+            ],
         ] = None,
         _request_auth: Optional[Dict[StrictStr, Any]] = None,
         _content_type: Optional[StrictStr] = None,
@@ -91,7 +100,7 @@ class FundingRatesApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """ # noqa: E501
+        """  # noqa: E501
 
         _param = self._funding_rate_funding_rates_symbol_get_serialize(
             symbol=symbol,
@@ -101,19 +110,18 @@ class FundingRatesApi:
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
-            _host_index=_host_index
+            _host_index=_host_index,
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BaseResponseListFundingRateResponse",
-            '400': "ErrorResponse",
-            '404': "ErrorResponse",
-            '500': "ErrorResponse",
-            '422': "HTTPValidationError",
+            "200": "BaseResponseListFundingRateResponse",
+            "400": "ErrorResponse",
+            "404": "ErrorResponse",
+            "500": "ErrorResponse",
+            "422": "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
+            *_param, _request_timeout=_request_timeout
         )
         response_data.read()
         return self.api_client.response_deserialize(
@@ -121,21 +129,28 @@ class FundingRatesApi:
             response_types_map=_response_types_map,
         ).data
 
-
     @validate_call
     def funding_rate_funding_rates_symbol_get_with_http_info(
         self,
-        symbol: Annotated[StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")],
-        start: Annotated[Optional[StrictInt], Field(description="Start timestamp in milliseconds")] = None,
-        end: Annotated[Optional[StrictInt], Field(description="End timestamp in milliseconds")] = None,
-        limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Number of funding rates to return")] = None,
+        symbol: Annotated[
+            StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")
+        ],
+        start: Annotated[
+            Optional[StrictInt], Field(description="Start timestamp in milliseconds")
+        ] = None,
+        end: Annotated[
+            Optional[StrictInt], Field(description="End timestamp in milliseconds")
+        ] = None,
+        limit: Annotated[
+            Optional[Annotated[int, Field(strict=True, ge=1)]],
+            Field(description="Number of funding rates to return"),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
             Tuple[
-                Annotated[StrictFloat, Field(gt=0)],
-                Annotated[StrictFloat, Field(gt=0)]
-            ]
+                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
+            ],
         ] = None,
         _request_auth: Optional[Dict[StrictStr, Any]] = None,
         _content_type: Optional[StrictStr] = None,
@@ -174,7 +189,7 @@ class FundingRatesApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """ # noqa: E501
+        """  # noqa: E501
 
         _param = self._funding_rate_funding_rates_symbol_get_serialize(
             symbol=symbol,
@@ -184,19 +199,18 @@ class FundingRatesApi:
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
-            _host_index=_host_index
+            _host_index=_host_index,
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BaseResponseListFundingRateResponse",
-            '400': "ErrorResponse",
-            '404': "ErrorResponse",
-            '500': "ErrorResponse",
-            '422': "HTTPValidationError",
+            "200": "BaseResponseListFundingRateResponse",
+            "400": "ErrorResponse",
+            "404": "ErrorResponse",
+            "500": "ErrorResponse",
+            "422": "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
+            *_param, _request_timeout=_request_timeout
         )
         response_data.read()
         return self.api_client.response_deserialize(
@@ -204,21 +218,28 @@ class FundingRatesApi:
             response_types_map=_response_types_map,
         )
 
-
     @validate_call
     def funding_rate_funding_rates_symbol_get_without_preload_content(
         self,
-        symbol: Annotated[StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")],
-        start: Annotated[Optional[StrictInt], Field(description="Start timestamp in milliseconds")] = None,
-        end: Annotated[Optional[StrictInt], Field(description="End timestamp in milliseconds")] = None,
-        limit: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Number of funding rates to return")] = None,
+        symbol: Annotated[
+            StrictStr, Field(description="Trading pair symbol (e.g., BTCUSDT)")
+        ],
+        start: Annotated[
+            Optional[StrictInt], Field(description="Start timestamp in milliseconds")
+        ] = None,
+        end: Annotated[
+            Optional[StrictInt], Field(description="End timestamp in milliseconds")
+        ] = None,
+        limit: Annotated[
+            Optional[Annotated[int, Field(strict=True, ge=1)]],
+            Field(description="Number of funding rates to return"),
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
             Tuple[
-                Annotated[StrictFloat, Field(gt=0)],
-                Annotated[StrictFloat, Field(gt=0)]
-            ]
+                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
+            ],
         ] = None,
         _request_auth: Optional[Dict[StrictStr, Any]] = None,
         _content_type: Optional[StrictStr] = None,
@@ -257,7 +278,7 @@ class FundingRatesApi:
                             in the spec for a single request.
         :type _host_index: int, optional
         :return: Returns the result object.
-        """ # noqa: E501
+        """  # noqa: E501
 
         _param = self._funding_rate_funding_rates_symbol_get_serialize(
             symbol=symbol,
@@ -267,23 +288,21 @@ class FundingRatesApi:
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
-            _host_index=_host_index
+            _host_index=_host_index,
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "BaseResponseListFundingRateResponse",
-            '400': "ErrorResponse",
-            '404': "ErrorResponse",
-            '500': "ErrorResponse",
-            '422': "HTTPValidationError",
+            "200": "BaseResponseListFundingRateResponse",
+            "400": "ErrorResponse",
+            "404": "ErrorResponse",
+            "500": "ErrorResponse",
+            "422": "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
-            *_param,
-            _request_timeout=_request_timeout
+            *_param, _request_timeout=_request_timeout
         )
         return response_data.response
 
-
     def _funding_rate_funding_rates_symbol_get_serialize(
         self,
         symbol,
@@ -298,8 +317,7 @@ class FundingRatesApi:
 
         _host = None
 
-        _collection_formats: Dict[str, str] = {
-        }
+        _collection_formats: Dict[str, str] = {}
 
         _path_params: Dict[str, str] = {}
         _query_params: List[Tuple[str, str]] = []
@@ -312,41 +330,36 @@ class FundingRatesApi:
 
         # process the path parameters
         if symbol is not None:
-            _path_params['symbol'] = symbol
+            _path_params["symbol"] = symbol
         # process the query parameters
         if start is not None:
-            
-            _query_params.append(('start', start))
-            
+
+            _query_params.append(("start", start))
+
         if end is not None:
-            
-            _query_params.append(('end', end))
-            
+
+            _query_params.append(("end", end))
+
         if limit is not None:
-            
-            _query_params.append(('limit', limit))
-            
+
+            _query_params.append(("limit", limit))
+
         # process the header parameters
         # process the form parameters
         # process the body parameter
 
-
         # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
-            _header_params['Accept'] = self.api_client.select_header_accept(
-                [
-                    'application/json'
-                ]
+        if "Accept" not in _header_params:
+            _header_params["Accept"] = self.api_client.select_header_accept(
+                ["application/json"]
             )
 
-
         # authentication setting
-        _auth_settings: List[str] = [
-        ]
+        _auth_settings: List[str] = []
 
         return self.api_client.param_serialize(
-            method='GET',
-            resource_path='/funding_rates/{symbol}',
+            method="GET",
+            resource_path="/funding_rates/{symbol}",
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -356,7 +369,5 @@ class FundingRatesApi:
             auth_settings=_auth_settings,
             collection_formats=_collection_formats,
             _host=_host,
-            _request_auth=_request_auth
+            _request_auth=_request_auth,
         )
-
-