datamaxi 0.1.0__tar.gz

datamaxi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bisonai
+
+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.

datamaxi-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include requirements/common.txt

datamaxi-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.1
+Name: datamaxi
+Version: 0.1.0
+Summary: Official Python client for DataMaxi+ API
+Author-email: Bisonai <business@bisonai.com>
+Project-URL: Homepage, https://github.com/bisonai/datamaxi-python
+Project-URL: Issues, https://github.com/bisonai/datamaxi-python/issues
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pandas
+
+# DataMaxi+ Python Client
+[![PyPI version](https://img.shields.io/pypi/v/datamaxi)](https://pypi.python.org/pypi/datamaxi)
+[![Python version](https://img.shields.io/pypi/pyversions/datamaxi)](https://www.python.org/downloads/)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://datamaxi.readthedocs.io/en/stable/)
+[![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is the official implementation of Python client for DataMaxi+ API.
+The package can be used to fetch both historical and latest data using [DataMaxi+ API](https://docs.neverest.finance/).
+This package is compatible with Python v3.8+.
+
+* [Installation](#installation)
+* [Configuration](#configuration)
+  * [Environment Variables](#environment-variables)
+* [Quickstart](#quickstart)
+* [Local Development](#local-development)
+  * [Setup](#setup)
+  * [Testing](#testing)
+* [Links](#links)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Installation
+
+```shell
+pip install datamaxi
+```
+
+## Configuration
+
+Access to DataMaxi+ is protected by API Key.
+If you are interested to try DataMaxi+, you can request your API key at [business@bisonai.com](mailto:business@bisonai.com).
+
+| Option             | Explanation                                                                           |
+|--------------------|---------------------------------------------------------------------------------------|
+| `api_key`          | Your API key                                                                          |
+| `base_url`         | If `base_url` is not provided, it defaults to `api.neverest.finance`.                 |
+| `timeout`          | Number of seconds to wait for a server response. By default requests do not time out. |
+| `proxies`          | Proxy through which the request is queried                                            |
+| `show_limit_usage` | Return response as dictionary including including `"limit_usage"` and `"data"` keys   |
+| `show_header`      | Return response as dictionary including including `"header"` and `"data"` keys        |
+
+### Environment Variables
+
+You may use environment variables to configure the DataMaxi+ client to avoid any inline boilerplate.
+
+| Env                | Description                                  |
+|--------------------|----------------------------------------------|
+| `NEVEREST_API_KEY` | Used instead of `api_key` if none is passed. |
+
+## Quickstart
+
+DataMaxi+ Python package currently includes the following clients:
+
+* `Binance`
+* `Defillama`
+* `Naver`
+* `Google`
+
+All clients accept the same parameters that are described at [Configuration](#configuration) section.
+First, import the clients,
+
+```python
+from datamaxi.binance import Binance
+from datamaxi.defillama import Defillama
+from datamaxi.naver import Naver
+from datamaxi.google import Google
+```
+
+and initialize them.
+
+```python
+binance = Binance(api_key=api_key)
+defillama = Defillama(api_key=api_key)
+naver = Naver(api_key=api_key)
+google = Google(api_key=api_key)
+```
+
+## Local Development
+
+### Setup
+
+If you wish to work on local development please clone/fork the git repo and use `pip install -r requirements.txt` to setup the project.
+
+### Testing
+
+```shell
+# In case packages are not installed yet
+pip install -r requirements/requirements-test.txt
+
+python -m pytest tests/
+```
+
+## Links
+
+* [DataMaxi+](https://datamaxiplus.com/)
+* [DataMaxi+ API](https://api.neverest.finance/)
+* [DataMaxi+ API Documentation](https://docs.neverest.finance/)
+
+## Contributing
+
+We welcome contributions!
+If you discover a bug in this project, please feel free to open an issue to discuss the changes you would like to propose.
+
+## License
+
+[MIT License](LICENSE)

datamaxi-0.1.0/README.md

@@ -0,0 +1,107 @@
+# DataMaxi+ Python Client
+[![PyPI version](https://img.shields.io/pypi/v/datamaxi)](https://pypi.python.org/pypi/datamaxi)
+[![Python version](https://img.shields.io/pypi/pyversions/datamaxi)](https://www.python.org/downloads/)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://datamaxi.readthedocs.io/en/stable/)
+[![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is the official implementation of Python client for DataMaxi+ API.
+The package can be used to fetch both historical and latest data using [DataMaxi+ API](https://docs.neverest.finance/).
+This package is compatible with Python v3.8+.
+
+* [Installation](#installation)
+* [Configuration](#configuration)
+  * [Environment Variables](#environment-variables)
+* [Quickstart](#quickstart)
+* [Local Development](#local-development)
+  * [Setup](#setup)
+  * [Testing](#testing)
+* [Links](#links)
+* [Contributing](#contributing)
+* [License](#license)
+
+## Installation
+
+```shell
+pip install datamaxi
+```
+
+## Configuration
+
+Access to DataMaxi+ is protected by API Key.
+If you are interested to try DataMaxi+, you can request your API key at [business@bisonai.com](mailto:business@bisonai.com).
+
+| Option             | Explanation                                                                           |
+|--------------------|---------------------------------------------------------------------------------------|
+| `api_key`          | Your API key                                                                          |
+| `base_url`         | If `base_url` is not provided, it defaults to `api.neverest.finance`.                 |
+| `timeout`          | Number of seconds to wait for a server response. By default requests do not time out. |
+| `proxies`          | Proxy through which the request is queried                                            |
+| `show_limit_usage` | Return response as dictionary including including `"limit_usage"` and `"data"` keys   |
+| `show_header`      | Return response as dictionary including including `"header"` and `"data"` keys        |
+
+### Environment Variables
+
+You may use environment variables to configure the DataMaxi+ client to avoid any inline boilerplate.
+
+| Env                | Description                                  |
+|--------------------|----------------------------------------------|
+| `NEVEREST_API_KEY` | Used instead of `api_key` if none is passed. |
+
+## Quickstart
+
+DataMaxi+ Python package currently includes the following clients:
+
+* `Binance`
+* `Defillama`
+* `Naver`
+* `Google`
+
+All clients accept the same parameters that are described at [Configuration](#configuration) section.
+First, import the clients,
+
+```python
+from datamaxi.binance import Binance
+from datamaxi.defillama import Defillama
+from datamaxi.naver import Naver
+from datamaxi.google import Google
+```
+
+and initialize them.
+
+```python
+binance = Binance(api_key=api_key)
+defillama = Defillama(api_key=api_key)
+naver = Naver(api_key=api_key)
+google = Google(api_key=api_key)
+```
+
+## Local Development
+
+### Setup
+
+If you wish to work on local development please clone/fork the git repo and use `pip install -r requirements.txt` to setup the project.
+
+### Testing
+
+```shell
+# In case packages are not installed yet
+pip install -r requirements/requirements-test.txt
+
+python -m pytest tests/
+```
+
+## Links
+
+* [DataMaxi+](https://datamaxiplus.com/)
+* [DataMaxi+ API](https://api.neverest.finance/)
+* [DataMaxi+ API Documentation](https://docs.neverest.finance/)
+
+## Contributing
+
+We welcome contributions!
+If you discover a bug in this project, please feel free to open an issue to discuss the changes you would like to propose.
+
+## License
+
+[MIT License](LICENSE)

datamaxi-0.1.0/datamaxi/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

datamaxi-0.1.0/datamaxi/api.py

@@ -0,0 +1,144 @@
+import os
+import json
+from json import JSONDecodeError
+import logging
+import requests
+from .__version__ import __version__
+from datamaxi.error import ClientError, ServerError
+from datamaxi.lib.utils import cleanNoneValue
+from datamaxi.lib.utils import encoded_string
+
+
+class API(object):
+    """The base class for all DataMaxi+ Python clients. `api_key` can be set
+    as an environment variable `NEVEREST_API_KEY`.
+    """
+
+    def __init__(
+        self,
+        api_key=None,
+        base_url=None,
+        timeout=None,
+        proxies=None,
+        show_limit_usage=False,
+        show_header=False,
+    ):
+        """Client API constructor. `api_key` can be set
+        as an environment variable `NEVEREST_API_KEY`.
+
+        Args:
+            api_key (str): The API key for the DataMaxi+ API.
+            base_url (str): The base URL for the DataMaxi+ API.
+            timeout (int): The timeout for the requests.
+            proxies (dict): The proxies for the requests.
+            show_limit_usage (bool): Show the limit usage.
+            show_header (bool): Show the header.
+        """
+        self.api_key = api_key or os.environ.get("NEVEREST_API_KEY")
+        self.base_url = base_url
+        self.timeout = timeout
+        self.proxies = None
+        self.show_limit_usage = False
+        self.show_header = False
+
+        self.session = requests.Session()
+        self.session.headers.update(
+            {
+                "Content-Type": "application/json;charset=utf-8",
+                "User-Agent": "datamaxi/" + __version__,
+                "Authorization": "X-NVRST-APIKEY " + str(self.api_key),
+            }
+        )
+
+        if show_limit_usage is True:
+            self.show_limit_usage = True
+
+        if show_header is True:
+            self.show_header = True
+
+        if type(proxies) is dict:
+            self.proxies = proxies
+
+        self._logger = logging.getLogger(__name__)
+        return
+
+    def query(self, url_path, payload=None):
+        return self.send_request("GET", url_path, payload=payload)
+
+    def send_request(self, http_method, url_path, payload=None):
+        if payload is None:
+            payload = {}
+        url = self.base_url + url_path
+        self._logger.debug("url: " + url)
+        params = cleanNoneValue(
+            {
+                "url": url,
+                "params": self._prepare_params(payload),
+                "timeout": self.timeout,
+                "proxies": self.proxies,
+            }
+        )
+        response = self._dispatch_request(http_method)(**params)
+        self._logger.debug("raw response from server:" + response.text)
+        self._handle_exception(response)
+
+        try:
+            data = response.json()
+        except ValueError:
+            data = response.text
+        result = {}
+
+        if self.show_limit_usage:
+            limit_usage = {}
+            for key in response.headers.keys():
+                key = key.lower()
+                if (
+                    key.startswith("x-ratelimit-limit")
+                    or key.startswith("x-ratelimit-remaining")
+                    or key.startswith("x-ratelimit-reset")
+                ):
+                    limit_usage[key] = response.headers[key]
+            result["limit_usage"] = limit_usage
+
+        if self.show_header:
+            result["header"] = response.headers
+
+        if len(result) != 0:
+            result["data"] = data
+            return result
+
+        return data
+
+    def _prepare_params(self, params):
+        return encoded_string(cleanNoneValue(params))
+
+    def _dispatch_request(self, http_method):
+        return {
+            "GET": self.session.get,
+            "DELETE": self.session.delete,
+            "PUT": self.session.put,
+            "POST": self.session.post,
+        }.get(http_method, "GET")
+
+    def _handle_exception(self, response):
+        status_code = response.status_code
+        if status_code < 400:
+            return
+        if 400 <= status_code < 500:
+            try:
+                err = json.loads(response.text)
+            except JSONDecodeError:
+                raise ClientError(
+                    status_code, None, response.text, None, response.headers
+                )
+            error_data = None
+            if "data" in err:
+                error_data = err["data"]
+            raise ClientError(
+                status_code,
+                err["code"],
+                err["msg"],
+                response.headers,
+                error_data,
+            )
+        raise ServerError(status_code, response.text)

datamaxi-0.1.0/datamaxi/binance/__init__.py

@@ -0,0 +1,56 @@
+from typing import Any, List, Union
+import pandas as pd
+from datamaxi.api import API
+from datamaxi.lib.utils import check_required_parameters
+from datamaxi.lib.utils import postprocess
+from datamaxi.lib.constants import BASE_URL
+
+
+class Binance(API):
+    """Client to fetch Binance data from DataMaxi+ API."""
+
+    def __init__(self, api_key=None, **kwargs: Any):
+        """Initialize the object.
+
+        Args:
+            api_key (str): The DataMaxi+ API key
+            **kwargs: Keyword arguments used by `datamaxi.api.API`.
+        """
+        if "base_url" not in kwargs:
+            kwargs["base_url"] = BASE_URL
+            super().__init__(api_key, **kwargs)
+
+    def symbols(self) -> List[str]:
+        """Supported Binance supported symbols
+
+        `GET /v1/raw/binance/symbols`
+
+        <https://docs.neverest.finance/cex/binance/symbols>
+
+        Returns:
+            List of supported Binance symbols
+        """
+        url_path = "/v1/raw/binance/symbols"
+        return self.query(url_path)
+
+    @postprocess()
+    def kline(
+        self, symbol: str, interval: str = "1d", pandas: bool = True
+    ) -> Union[List, pd.DataFrame]:
+        """Get Binance k-line data
+
+        `GET /v1/raw/binance/kline`
+
+        <https://docs.neverest.finance/cex/binance/kline>
+
+        Args:
+            symbol (str): Binance symbol
+            interval (str): Kline interval
+            pandas (bool): Return data as pandas DataFrame
+
+        Returns:
+            Binance kline data for a given symbol and interval in pandas DataFrame
+        """
+        check_required_parameters([[symbol, "symbol"], [interval, "interval"]])
+        params = {"symbol": symbol, "interval": interval}
+        return self.query("/v1/raw/binance/kline", params)