crypticorn 2.7.4__py3-none-any.whl → 2.8.0__py3-none-any.whl

crypticorn/pay/client/api/status_api.py

@@ -17,7 +17,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import StrictStr, field_validator
-from typing import Any, Dict, Optional
+from typing import Optional
 
 from crypticorn.pay.client.api_client import ApiClient, RequestSerialized
 from crypticorn.pay.client.api_response import ApiResponse
@@ -36,233 +36,6 @@ class StatusApi:
             api_client = ApiClient.get_default()
         self.api_client = api_client
 
-    @validate_call
-    async def get_config(
-        self,
-        _request_timeout: Union[
-            None,
-            Annotated[StrictFloat, Field(gt=0)],
-            Tuple[
-                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
-            ],
-        ] = None,
-        _request_auth: Optional[Dict[StrictStr, Any]] = None,
-        _content_type: Optional[StrictStr] = None,
-        _headers: Optional[Dict[StrictStr, Any]] = None,
-        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> Dict[str, object]:
-        """Config
-
-        Returns the version of the crypticorn library and the environment.
-
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :type _request_timeout: int, tuple(int, int), optional
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the
-                              authentication in the spec for a single request.
-        :type _request_auth: dict, optional
-        :param _content_type: force content-type for the request.
-        :type _content_type: str, Optional
-        :param _headers: set to override the headers for a single
-                         request; this effectively ignores the headers
-                         in the spec for a single request.
-        :type _headers: dict, optional
-        :param _host_index: set to override the host_index for a single
-                            request; this effectively ignores the host_index
-                            in the spec for a single request.
-        :type _host_index: int, optional
-        :return: Returns the result object.
-        """  # noqa: E501
-
-        _param = self._get_config_serialize(
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index,
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            "200": "Dict[str, object]",
-        }
-        response_data = await self.api_client.call_api(
-            *_param, _request_timeout=_request_timeout
-        )
-        await response_data.read()
-        return self.api_client.response_deserialize(
-            response_data=response_data,
-            response_types_map=_response_types_map,
-        ).data
-
-    @validate_call
-    async def get_config_with_http_info(
-        self,
-        _request_timeout: Union[
-            None,
-            Annotated[StrictFloat, Field(gt=0)],
-            Tuple[
-                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
-            ],
-        ] = None,
-        _request_auth: Optional[Dict[StrictStr, Any]] = None,
-        _content_type: Optional[StrictStr] = None,
-        _headers: Optional[Dict[StrictStr, Any]] = None,
-        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[Dict[str, object]]:
-        """Config
-
-        Returns the version of the crypticorn library and the environment.
-
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :type _request_timeout: int, tuple(int, int), optional
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the
-                              authentication in the spec for a single request.
-        :type _request_auth: dict, optional
-        :param _content_type: force content-type for the request.
-        :type _content_type: str, Optional
-        :param _headers: set to override the headers for a single
-                         request; this effectively ignores the headers
-                         in the spec for a single request.
-        :type _headers: dict, optional
-        :param _host_index: set to override the host_index for a single
-                            request; this effectively ignores the host_index
-                            in the spec for a single request.
-        :type _host_index: int, optional
-        :return: Returns the result object.
-        """  # noqa: E501
-
-        _param = self._get_config_serialize(
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index,
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            "200": "Dict[str, object]",
-        }
-        response_data = await self.api_client.call_api(
-            *_param, _request_timeout=_request_timeout
-        )
-        await response_data.read()
-        return self.api_client.response_deserialize(
-            response_data=response_data,
-            response_types_map=_response_types_map,
-        )
-
-    @validate_call
-    async def get_config_without_preload_content(
-        self,
-        _request_timeout: Union[
-            None,
-            Annotated[StrictFloat, Field(gt=0)],
-            Tuple[
-                Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
-            ],
-        ] = None,
-        _request_auth: Optional[Dict[StrictStr, Any]] = None,
-        _content_type: Optional[StrictStr] = None,
-        _headers: Optional[Dict[StrictStr, Any]] = None,
-        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> RESTResponseType:
-        """Config
-
-        Returns the version of the crypticorn library and the environment.
-
-        :param _request_timeout: timeout setting for this request. If one
-                                 number provided, it will be total request
-                                 timeout. It can also be a pair (tuple) of
-                                 (connection, read) timeouts.
-        :type _request_timeout: int, tuple(int, int), optional
-        :param _request_auth: set to override the auth_settings for an a single
-                              request; this effectively ignores the
-                              authentication in the spec for a single request.
-        :type _request_auth: dict, optional
-        :param _content_type: force content-type for the request.
-        :type _content_type: str, Optional
-        :param _headers: set to override the headers for a single
-                         request; this effectively ignores the headers
-                         in the spec for a single request.
-        :type _headers: dict, optional
-        :param _host_index: set to override the host_index for a single
-                            request; this effectively ignores the host_index
-                            in the spec for a single request.
-        :type _host_index: int, optional
-        :return: Returns the result object.
-        """  # noqa: E501
-
-        _param = self._get_config_serialize(
-            _request_auth=_request_auth,
-            _content_type=_content_type,
-            _headers=_headers,
-            _host_index=_host_index,
-        )
-
-        _response_types_map: Dict[str, Optional[str]] = {
-            "200": "Dict[str, object]",
-        }
-        response_data = await self.api_client.call_api(
-            *_param, _request_timeout=_request_timeout
-        )
-        return response_data.response
-
-    def _get_config_serialize(
-        self,
-        _request_auth,
-        _content_type,
-        _headers,
-        _host_index,
-    ) -> RequestSerialized:
-
-        _host = None
-
-        _collection_formats: Dict[str, str] = {}
-
-        _path_params: Dict[str, str] = {}
-        _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
-        _form_params: List[Tuple[str, str]] = []
-        _files: Dict[
-            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
-        ] = {}
-        _body_params: Optional[bytes] = None
-
-        # process the path parameters
-        # process the query parameters
-        # 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"]
-            )
-
-        # authentication setting
-        _auth_settings: List[str] = []
-
-        return self.api_client.param_serialize(
-            method="GET",
-            resource_path="/config",
-            path_params=_path_params,
-            query_params=_query_params,
-            header_params=_header_params,
-            body=_body_params,
-            post_params=_form_params,
-            files=_files,
-            auth_settings=_auth_settings,
-            collection_formats=_collection_formats,
-            _host=_host,
-            _request_auth=_request_auth,
-        )
-
     @validate_call
     async def get_time(
         self,
@@ -281,7 +54,7 @@ class StatusApi:
     ) -> str:
         """Time
 
-        Returns the current time in the specified format.
+        Returns the current time in either ISO or Unix timestamp (seconds) format.
 
         :param type:
         :type type: str
@@ -345,7 +118,7 @@ class StatusApi:
     ) -> ApiResponse[str]:
         """Time
 
-        Returns the current time in the specified format.
+        Returns the current time in either ISO or Unix timestamp (seconds) format.
 
         :param type:
         :type type: str
@@ -409,7 +182,7 @@ class StatusApi:
     ) -> RESTResponseType:
         """Time
 
-        Returns the current time in the specified format.
+        Returns the current time in either ISO or Unix timestamp (seconds) format.
 
         :param type:
         :type type: str

crypticorn/pay/client/models/__init__.py

@@ -15,6 +15,7 @@ Do not edit the class manually.
 
 # import models into model package
 from crypticorn.pay.client.models.exception_detail import ExceptionDetail
+from crypticorn.pay.client.models.log_level import LogLevel
 from crypticorn.pay.client.models.now_create_invoice_req import NowCreateInvoiceReq
 from crypticorn.pay.client.models.now_create_invoice_res import NowCreateInvoiceRes
 from crypticorn.pay.client.models.payment import Payment
@@ -24,4 +25,5 @@ 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.provider import Provider
+from crypticorn.pay.client.models.response_getuptime import ResponseGetuptime
 from crypticorn.pay.client.models.scope import Scope

crypticorn/pay/client/models/log_level.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+Payment API
+
+API for accepting payments and storing subscriptions
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class LogLevel(str, Enum):
+    """
+    LogLevel
+    """
+
+    """
+    allowed enum values
+    """
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    CRITICAL = "CRITICAL"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of LogLevel from a JSON string"""
+        return cls(json.loads(json_str))

crypticorn/{hive/client/models/data_value_value_value_inner.py → pay/client/models/response_getuptime.py}

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-Hive AI API
+Payment API
 
-API for Hive AI model training and evaluation
+API for accepting payments and storing subscriptions
 
 The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -21,34 +21,33 @@ from pydantic import (
     BaseModel,
     ConfigDict,
     Field,
+    StrictInt,
     StrictStr,
     ValidationError,
     field_validator,
 )
 from typing import Optional
-from crypticorn.hive.client.models.feature_size import FeatureSize
-from crypticorn.hive.client.models.target import Target
 from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-DATAVALUEVALUEVALUEINNER_ANY_OF_SCHEMAS = ["FeatureSize", "Target"]
+RESPONSEGETUPTIME_ANY_OF_SCHEMAS = ["int", "str"]
 
 
-class DataValueValueValueInner(BaseModel):
+class ResponseGetuptime(BaseModel):
     """
-    DataValueValueValueInner
+    ResponseGetuptime
     """
 
-    # data type: FeatureSize
-    anyof_schema_1_validator: Optional[FeatureSize] = None
-    # data type: Target
-    anyof_schema_2_validator: Optional[Target] = None
+    # data type: int
+    anyof_schema_1_validator: Optional[StrictInt] = None
+    # data type: str
+    anyof_schema_2_validator: Optional[StrictStr] = None
     if TYPE_CHECKING:
-        actual_instance: Optional[Union[FeatureSize, Target]] = None
+        actual_instance: Optional[Union[int, str]] = None
     else:
         actual_instance: Any = None
-    any_of_schemas: Set[str] = {"FeatureSize", "Target"}
+    any_of_schemas: Set[str] = {"int", "str"}
 
     model_config = {
         "validate_assignment": True,
@@ -71,24 +70,24 @@ class DataValueValueValueInner(BaseModel):
 
     @field_validator("actual_instance")
     def actual_instance_must_validate_anyof(cls, v):
-        instance = DataValueValueValueInner.model_construct()
+        instance = ResponseGetuptime.model_construct()
         error_messages = []
-        # validate data type: FeatureSize
-        if not isinstance(v, FeatureSize):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `FeatureSize`")
-        else:
+        # validate data type: int
+        try:
+            instance.anyof_schema_1_validator = v
             return v
-
-        # validate data type: Target
-        if not isinstance(v, Target):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `Target`")
-        else:
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: str
+        try:
+            instance.anyof_schema_2_validator = v
             return v
-
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
         if error_messages:
             # no match
             raise ValueError(
-                "No match found when setting the actual_instance in DataValueValueValueInner with anyOf schemas: FeatureSize, Target. Details: "
+                "No match found when setting the actual_instance in ResponseGetuptime with anyOf schemas: int, str. Details: "
                 + ", ".join(error_messages)
             )
         else:
@@ -103,15 +102,21 @@ class DataValueValueValueInner(BaseModel):
         """Returns the object represented by the json string"""
         instance = cls.model_construct()
         error_messages = []
-        # anyof_schema_1_validator: Optional[FeatureSize] = None
+        # deserialize data into int
         try:
-            instance.actual_instance = FeatureSize.from_json(json_str)
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
             return instance
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
-        # anyof_schema_2_validator: Optional[Target] = None
+        # deserialize data into str
         try:
-            instance.actual_instance = Target.from_json(json_str)
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
             return instance
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
@@ -119,7 +124,7 @@ class DataValueValueValueInner(BaseModel):
         if error_messages:
             # no match
             raise ValueError(
-                "No match found when deserializing the JSON string into DataValueValueValueInner with anyOf schemas: FeatureSize, Target. Details: "
+                "No match found when deserializing the JSON string into ResponseGetuptime with anyOf schemas: int, str. Details: "
                 + ", ".join(error_messages)
             )
         else:
@@ -137,7 +142,7 @@ class DataValueValueValueInner(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], FeatureSize, Target]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], int, str]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

crypticorn/pay/client/models/scope.py

@@ -26,6 +26,8 @@ class Scope(str, Enum):
     """
     allowed enum values
     """
+    WRITE_COLON_ADMIN = "write:admin"
+    READ_COLON_ADMIN = "read:admin"
     READ_COLON_PREDICTIONS = "read:predictions"
     READ_COLON_HIVE_COLON_MODEL = "read:hive:model"
     READ_COLON_HIVE_COLON_DATA = "read:hive:data"

crypticorn/pay/main.py

@@ -5,6 +5,7 @@ from crypticorn.pay import (
     StatusApi,
     PaymentsApi,
     ProductsApi,
+    AdminApi,
 )
 
 
@@ -25,3 +26,4 @@ class PayClient:
         self.status = StatusApi(self.base_client)
         self.payments = PaymentsApi(self.base_client)
         self.products = ProductsApi(self.base_client)
+        self.admin = AdminApi(self.base_client)

{crypticorn-2.7.4.dist-info → crypticorn-2.8.0.dist-info}/METADATA

@@ -1,21 +1,29 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.7.4
+Version: 2.8.0
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License: MIT
 Project-URL: Homepage, https://crypticorn.com
+Project-URL: Documentation, https://docs.crypticorn.com
+Project-URL: Dashboard, https://app.crypticorn.com
 Keywords: machine learning,data science,crypto,modelling
 Classifier: Topic :: Scientific/Engineering
 Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi<1.0.0,>=0.115.0
 Requires-Dist: click<9.0.0,>=8.0.0
+Requires-Dist: psutil<8.0.0,>=7.0.0
+Requires-Dist: setuptools<81.0.0,>=80.0.0
 Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python_dateutil<3.0.0,>=2.8.2
 Requires-Dist: aiohttp<4.0.0,>=3.8.4
@@ -34,6 +42,7 @@ 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"
+Requires-Dist: pdoc==15.0.3; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest==8.3.5; extra == "test"
 Requires-Dist: pytest-asyncio==0.26.0; extra == "test"
@@ -52,9 +61,9 @@ crypto market - and programmatically interact with the entire Crypticorn ecosyst
 
 ## Installation
 
->Python 3.10+ required
+You need Python 3.10+ installed to be able to use this library.
 
-You can install the latest stable version from PyPi:
+You can install the latest stable version from [PyPi](https://pypi.org/project/crypticorn/):
 ```bash
 pip install crypticorn
 ```
@@ -64,7 +73,7 @@ If you want the latest version, which could be a pre release, run:
 pip install --pre crypticorn
 ```
 
-You can install extra dependencies grouped in the extras `extra` (heavy dependencies that do not come with the default version) `dev` (development) and `test` (testing). The `extra` dependencies include heavy libraries like `pandas`, which is only used in a few custom API operations (suffixed with `_fmt`), which preprocess the response data as a pandas Dataframe for convenience.
+You can install extra dependencies grouped in the extras `extra`, `dev` (development) and `test` (testing). The `extra` dependencies include heavy libraries like `pandas`, which is only used in a few custom API operations (see [data processing](#data-preprocessing)), which preprocess the response data as a pandas Dataframe for convenience.
 
 ## Structure
 
@@ -72,11 +81,13 @@ Our API is available as an asynchronous Python SDK. The main entry point you nee
 ```python
 from crypticorn import ApiClient
 ```
-The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our micro services.
+The ApiClient serves as the central interface for API operations. It instantiates multiple API wrappers corresponding to our micro services. These are structured the following:
 
-Request and response models for API operations should be accessed through the appropriate sub package.
+<img src="../static/pip-structure.svg" alt="pip package structure" />
 
-Note: All symbols are re-exported at the sub package level for convenience.
+You can either explore each API by clicking through the library or checkout the [API Documentation](https://docs.crypticorn.com/api).
+
+Request and response models for API operations should be accessed through the sub package you are using for an operation. All symbols are re-exported at the sub package level for convenience.
 
 ```python
 from crypticorn.trade import BotStatus
@@ -93,25 +104,27 @@ To get started, [create an API key in your dashboard](https://app.crypticorn.com
 
 ## Basic Usage
 
-### With Async Context Protocol
+You can use the client with the async context protocol...
 ```python
-async with ApiClient(base_url=BaseUrl.Prod, api_key="your-api-key") as client:
+async with ApiClient(api_key="your-api-key") as client:
         await client.pay.products.get_products()
 ```
-
-### Without Async Context Protocol
-Without the context you need to close the session manually.
+...or without it like this...
 ```python
-client = ApiClient(base_url=BaseUrl.Prod, api_key="your-api-key")
+client = ApiClient(api_key="your-api-key")
 asyncio.run(client.pay.models.get_products())
 asyncio.run(client.close())
 ```
-...or wrapped in a function
+...or this.
+```python
+client = ApiClient(api_key="your-api-key")
+
 async def main():
     await client.pay.products.get_products()
 
 asyncio.run(main())
 asyncio.run(client.close())
+```
 
 ## Response Types
 
@@ -120,8 +133,8 @@ There are three different available output formats you can choose from:
 ### Serialized Response
 You can get fully serialized responses as pydantic models. Using this, you get the full benefits of pydantic's type checking.
 ```python
-response = await client.pay.products.get_products()
-print(response)
+res = await client.pay.products.get_products()
+print(res)
 ```
 The output would look like this:
 ```python
@@ -130,7 +143,7 @@ The output would look like this:
 
 ### Serialized Response with HTTP Info
 ```python
-await client.pay.products.get_products_with_http_info()
+res = await client.pay.products.get_products_with_http_info()
 print(res)
 ```
 The output would look like this:
@@ -159,15 +172,27 @@ The output would look like this:
 [{'id': '67e8146e7bae32f3838fe36a', 'name': 'Awesome Product', 'price': 5.0, 'duration': 30, 'description': 'You need to buy this', 'is_active': True}]
 ```
 
+## Wrapper Utilities
+
+Our SDK provides a collection of wrapper utilities designed to make interacting with the API more efficient and user-friendly.
+
+### Data Preprocessing
+Some API operations allow to get the returned data formatted as a pandas Dataframe. These operations are suffixed with `_fmt` and take the same inputs as the non-formatted function. They live alongside the other functions with the default [response types](#response-types). To use this functionality you have to install `pandas`, which is available in the [`extra` dependency group](#installation).
+
+### Data Downloads
+This utility allows direct data streaming to your local disk, instead of only returning download links. It is being used in the following functions:
+- `client.hive.data.download_data()` (overrides the [default response](https://docs.crypticorn.com/api/?api=hive-ai-api#tag/data/GET/data))
+
 ## Advanced Usage
 
 You can override some configuration for specific services. If you just want to use the API as is, you don't need to configure anything.
 This might be of use if you are testing a specific API locally.
 
-To override e.g. the host for the Hive client to connect to http://localhost:8000 instead of the default proxy, you would do:
+To override e.g. the host for the Hive client to connect to localhost:8000 instead of the default proxy, you would do:
 ```python
 from crypticorn.hive import Configuration as Hiveconfig
 from crypticorn.common import Service
-async with ApiClient(base_url=BaseUrl.DEV) as client:
+
+async with ApiClient() as client:
         client.configure(config=HiveConfig(host="http://localhost:8000"), client=Service.HIVE)
 ```