crypticorn 1.0.0__tar.gz

crypticorn-1.0.0/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Crypticorn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

crypticorn-1.0.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.1
+Name: crypticorn
+Version: 1.0.0
+Summary: Maximise Your Crypto Trading Profits with AI Predictions
+Author-email: Crypticorn <timon@crypticorn.com>
+License: MIT License
+Project-URL: homepage, https://crypticorn.com
+Project-URL: documentation, https://docs.crypticorn.com
+Keywords: machine learning,data science,crypto,modelling
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pandas<3.0.0,>=2.2.0
+Requires-Dist: requests<3.0.0,>=2.32.0
+
+# What is Crypticorn?
+
+Crypticorn is at the forefront of cutting-edge artificial intelligence cryptocurrency trading.
+Crypticorn offers AI-based solutions for both active and passive investors, including:
+ - Prediction Dashboard with trading terminal,
+ - AI Trading Bots with different strategies,
+ - DEX AI Signals for newly launched tokens,
+ - DEX AI Bots
+
+Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
+cryptocurrency market.
+

crypticorn-1.0.0/README.md

@@ -0,0 +1,12 @@
+# What is Crypticorn?
+
+Crypticorn is at the forefront of cutting-edge artificial intelligence cryptocurrency trading.
+Crypticorn offers AI-based solutions for both active and passive investors, including:
+ - Prediction Dashboard with trading terminal,
+ - AI Trading Bots with different strategies,
+ - DEX AI Signals for newly launched tokens,
+ - DEX AI Bots
+
+Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
+cryptocurrency market.
+

crypticorn-1.0.0/crypticorn/__init__.py

@@ -0,0 +1,8 @@
+"""
+.. include:: ../README.md
+.. include:: ../CHANGELOG.md
+"""
+
+from .api import Crypticorn
+
+__all__ = ['Crypticorn']

crypticorn-1.0.0/crypticorn/api.py

@@ -0,0 +1,107 @@
+from typing import Any
+import pandas as pd
+import requests
+import os
+from .utils import download_file, SingleModel, ModelEvaluation, DataInfo
+
+
+class Crypticorn:
+    """
+    A client for interacting with the crypticorn API, offering functionality to create and evaluate models,
+    download data, and retrieve information about available coins, targets, and features.
+    """
+
+    def __init__(self, api_key: str, headers: dict = None, base_url='https://api.crypticorn.com'):
+        """@private
+        Initializes the crypticorn 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 = headers if headers else {"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
+        )
+        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()

crypticorn-1.0.0/crypticorn/utils.py

@@ -0,0 +1,109 @@
+import requests
+import os
+import tqdm
+import logging
+from pydantic import BaseModel
+from typing import List, Dict, Any
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
+if not logger.handlers:
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.INFO)
+
+    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+    console_handler.setFormatter(formatter)
+
+    logger.addHandler(console_handler)
+
+def download_file(url: str, dest_path: str, show_progress_bars: bool = True):
+    """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
+
+
+class SingleModel(BaseModel):
+    coin_id: int
+    evaluations: List[Dict[str, Any]]
+    created: str
+    model_id: int
+    name: str
+    status: str
+    target: str
+    updated: str
+    dev_id: str
+    target_type: str
+    class Config:
+        protected_namespaces = ()
+    
+    
+class AllModels(BaseModel):
+    models: List[SingleModel]
+
+
+class AccountInfo(BaseModel):
+    api_key: bool
+    models: List[SingleModel]
+    user_id: str
+    username: str
+    updated: str
+    created: str
+
+
+class ModelEvaluation(BaseModel):
+    benchmarks: Dict[str, Dict[str, Any]]
+    metrics: Dict[str, Any]
+
+
+class ApiKeyGeneration(BaseModel):
+    api_key: str
+
+
+class DataInfo(BaseModel):
+    data: Dict[str, Dict[str, Dict[str, List[str]]]]
+    coins: List[str]
+    feature_sizes: List[str]
+    targets: Dict[str, str]
+    versions: Dict[str, float]

crypticorn-1.0.0/crypticorn.egg-info/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.1
+Name: crypticorn
+Version: 1.0.0
+Summary: Maximise Your Crypto Trading Profits with AI Predictions
+Author-email: Crypticorn <timon@crypticorn.com>
+License: MIT License
+Project-URL: homepage, https://crypticorn.com
+Project-URL: documentation, https://docs.crypticorn.com
+Keywords: machine learning,data science,crypto,modelling
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pandas<3.0.0,>=2.2.0
+Requires-Dist: requests<3.0.0,>=2.32.0
+
+# What is Crypticorn?
+
+Crypticorn is at the forefront of cutting-edge artificial intelligence cryptocurrency trading.
+Crypticorn offers AI-based solutions for both active and passive investors, including:
+ - Prediction Dashboard with trading terminal,
+ - AI Trading Bots with different strategies,
+ - DEX AI Signals for newly launched tokens,
+ - DEX AI Bots
+
+Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
+cryptocurrency market.
+

crypticorn-1.0.0/crypticorn.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.md
+README.md
+pyproject.toml
+crypticorn/__init__.py
+crypticorn/api.py
+crypticorn/utils.py
+crypticorn.egg-info/PKG-INFO
+crypticorn.egg-info/SOURCES.txt
+crypticorn.egg-info/dependency_links.txt
+crypticorn.egg-info/requires.txt
+crypticorn.egg-info/top_level.txt

crypticorn-1.0.0/crypticorn.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

crypticorn-1.0.0/crypticorn.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pandas<3.0.0,>=2.2.0
+requests<3.0.0,>=2.32.0

crypticorn-1.0.0/crypticorn.egg-info/top_level.txt

@@ -0,0 +1 @@
+crypticorn

crypticorn-1.0.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "crypticorn"
+description = "Maximise Your Crypto Trading Profits with AI Predictions"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT License"}
+authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
+version = "1.0.0"
+keywords = ["machine learning", "data science", "crypto", "modelling"]
+
+dependencies = [
+    "pandas >= 2.2.0, < 3.0.0",
+    "requests >= 2.32.0, < 3.0.0",
+]
+
+classifiers = [
+    "Topic :: Scientific/Engineering",
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Typing :: Typed",
+]
+
+[project.urls]
+homepage = "https://crypticorn.com"
+documentation = "https://docs.crypticorn.com"
+
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

crypticorn-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+