crypticorn 1.0.1__py3-none-any.whl → 1.0.2rc2__py3-none-any.whl

crypticorn/klines/client/rest.py

@@ -0,0 +1,257 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from crypticorn.klines.client.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :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.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

crypticorn/klines/main.py

@@ -0,0 +1,42 @@
+from crypticorn.klines import FundingRatesApi, OHLCVDataApi, SymbolsApi, UDFApi, HealthCheckApi, Configuration, ApiClient
+import pandas as pd
+
+class FundingRatesApiWrapper(FundingRatesApi):
+    def get_funding_rates_fmt(self):
+        response = self.funding_rate_funding_rates_symbol_get()
+        return pd.DataFrame(response.json())
+    
+class OHLCVDataApiWrapper(OHLCVDataApi):
+    def get_ohlcv_data_fmt(self):
+        response = self.get_ohlcv_market_timeframe_symbol_get()
+        return pd.DataFrame(response.json())
+    
+class SymbolsApiWrapper(SymbolsApi):
+    def get_symbols_fmt(self):
+        response = self.symbols_symbols_market_get()
+        return pd.DataFrame(response.json())
+    
+class UDFApiWrapper(UDFApi):
+    def get_udf_fmt(self):
+        response = self.get_history_udf_history_get()
+        return pd.DataFrame(response.json())
+
+class KlinesClient:
+    """
+    A client for interacting with the Crypticorn Klines API.
+    """
+
+    def __init__(self, base_url: str = 'https://api.crypticorn.dev', api_key: str = None, jwt: str = None):
+        # Configure Klines client
+        self.host = f"{base_url}/v1/klines"
+        klines_config = Configuration(
+            host=self.host,
+        )
+        base_client = ApiClient(configuration=klines_config)
+        # Instantiate all the endpoint clients
+        self.funding = FundingRatesApiWrapper(base_client)
+        self.ohlcv = OHLCVDataApiWrapper(base_client)
+        self.symbols = SymbolsApiWrapper(base_client)
+        self.udf = UDFApiWrapper(base_client)
+        self.health = HealthCheckApi(base_client)
+

crypticorn/klines/requirements.txt

@@ -0,0 +1,4 @@
+urllib3 >= 1.25.3, < 3.0.0
+python_dateutil >= 2.8.2
+pydantic >= 2
+typing-extensions >= 4.7.1

crypticorn/klines/test/test_base_response_health_check_response.py

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import unittest
+
+from crypticorn.klines.client.models.base_response_health_check_response import BaseResponseHealthCheckResponse
+
+class TestBaseResponseHealthCheckResponse(unittest.TestCase):
+    """BaseResponseHealthCheckResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BaseResponseHealthCheckResponse:
+        """Test BaseResponseHealthCheckResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BaseResponseHealthCheckResponse`
+        """
+        model = BaseResponseHealthCheckResponse()
+        if include_optional:
+            return BaseResponseHealthCheckResponse(
+                success = True,
+                message = '',
+                data = client.models.health_check_response.HealthCheckResponse(
+                    status = 'ok', 
+                    version = '1.0.0', ),
+                timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
+            )
+        else:
+            return BaseResponseHealthCheckResponse(
+        )
+        """
+
+    def testBaseResponseHealthCheckResponse(self):
+        """Test BaseResponseHealthCheckResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/klines/test/test_base_response_list_funding_rate_response.py

@@ -0,0 +1,59 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import unittest
+
+from crypticorn.klines.client.models.base_response_list_funding_rate_response import BaseResponseListFundingRateResponse
+
+class TestBaseResponseListFundingRateResponse(unittest.TestCase):
+    """BaseResponseListFundingRateResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BaseResponseListFundingRateResponse:
+        """Test BaseResponseListFundingRateResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BaseResponseListFundingRateResponse`
+        """
+        model = BaseResponseListFundingRateResponse()
+        if include_optional:
+            return BaseResponseListFundingRateResponse(
+                success = True,
+                message = '',
+                data = [
+                    client.models.funding_rate_response.FundingRateResponse(
+                        symbol = '', 
+                        timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                        funding_rate = 1.337, )
+                    ],
+                timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
+            )
+        else:
+            return BaseResponseListFundingRateResponse(
+        )
+        """
+
+    def testBaseResponseListFundingRateResponse(self):
+        """Test BaseResponseListFundingRateResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/klines/test/test_base_response_list_str.py

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import unittest
+
+from crypticorn.klines.client.models.base_response_list_str import BaseResponseListStr
+
+class TestBaseResponseListStr(unittest.TestCase):
+    """BaseResponseListStr unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BaseResponseListStr:
+        """Test BaseResponseListStr
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BaseResponseListStr`
+        """
+        model = BaseResponseListStr()
+        if include_optional:
+            return BaseResponseListStr(
+                success = True,
+                message = '',
+                data = [
+                    ''
+                    ],
+                timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
+            )
+        else:
+            return BaseResponseListStr(
+        )
+        """
+
+    def testBaseResponseListStr(self):
+        """Test BaseResponseListStr"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/klines/test/test_base_response_ohlcv_response.py

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import unittest
+
+from crypticorn.klines.client.models.base_response_ohlcv_response import BaseResponseOHLCVResponse
+
+class TestBaseResponseOHLCVResponse(unittest.TestCase):
+    """BaseResponseOHLCVResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BaseResponseOHLCVResponse:
+        """Test BaseResponseOHLCVResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BaseResponseOHLCVResponse`
+        """
+        model = BaseResponseOHLCVResponse()
+        if include_optional:
+            return BaseResponseOHLCVResponse(
+                success = True,
+                message = '',
+                data = client.models.ohlcv_response.OHLCVResponse(
+                    timestamp = [
+                        datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
+                        ], 
+                    open = [
+                        1.337
+                        ], 
+                    high = [
+                        1.337
+                        ], 
+                    low = [
+                        1.337
+                        ], 
+                    close = [
+                        1.337
+                        ], 
+                    volume = [
+                        1.337
+                        ], ),
+                timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
+            )
+        else:
+            return BaseResponseOHLCVResponse(
+        )
+        """
+
+    def testBaseResponseOHLCVResponse(self):
+        """Test BaseResponseOHLCVResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/klines/test/test_error_response.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import unittest
+
+from crypticorn.klines.client.models.error_response import ErrorResponse
+
+class TestErrorResponse(unittest.TestCase):
+    """ErrorResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> ErrorResponse:
+        """Test ErrorResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `ErrorResponse`
+        """
+        model = ErrorResponse()
+        if include_optional:
+            return ErrorResponse(
+                success = True,
+                message = '',
+                error_code = '',
+                details = None,
+                timestamp = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f')
+            )
+        else:
+            return ErrorResponse(
+                message = '',
+                error_code = '',
+        )
+        """
+
+    def testErrorResponse(self):
+        """Test ErrorResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

crypticorn/klines/test/test_exchange.py

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+"""
+    Klines Service API
+
+         API for retrieving OHLCV data, funding rates, and symbol information from Binance.          ## WebSocket Support     Connect to `/ws` to receive real-time OHLCV updates.          Example subscription message:     ```json     {         \"action\": \"subscribe\",         \"market\": \"spot\",         \"symbol\": \"BTCUSDT\",         \"timeframe\": \"15m\"     }     ```     
+
+    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
+
+
+import unittest
+
+from crypticorn.klines.client.models.exchange import Exchange
+
+class TestExchange(unittest.TestCase):
+    """Exchange unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> Exchange:
+        """Test Exchange
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `Exchange`
+        """
+        model = Exchange()
+        if include_optional:
+            return Exchange(
+                value = '',
+                name = '',
+                desc = ''
+            )
+        else:
+            return Exchange(
+                value = '',
+                name = '',
+                desc = '',
+        )
+        """
+
+    def testExchange(self):
+        """Test Exchange"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()