unicex 0.1.18__tar.gz → 0.4.0__tar.gz

unicex-0.4.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: unicex
+Version: 0.4.0
+Summary: Unified Crypto Exchange API 
+Author-email: LoveBloodAndDiamonds <ayazshakirzyanov27@gmail.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, LoveBloodAndDiamonds
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Github, https://github.com/LoveBloodAndDiamonds/uni-cex-api
+Project-URL: Author, https://t.me/LoveBloodAndDiamonds
+Project-URL: Readthedocs, https://unicex.readthedocs.io/ru/latest/
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.12.15
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: orjson>=3.11.3
+Requires-Dist: websockets>=15.0.1
+Dynamic: license-file
+
+# Unified Crypto Exchange API
+
+`unicex` — асинхронная библиотека для работы с криптовалютными биржами, реализующая унифицированный интерфейс поверх «сырых» REST и WebSocket API разных бирж.
+
+## ✅ Статус реализации
+
+## ✅ Статус реализации
+
+| Exchange    | Client | Client Auth | Client Generic | WS Manager | User WS |
+|-------------|--------|-------------|----------------|------------|---------|
+| Binance     | ✅     | ✅          | ✅             | ✅         | ✅      |
+| Bitget      | ✅     | ✅          | ✅             | ✅         |         |
+| Bitrue      |        | ✅          | ✅             |            |         |
+| Bitunix     |        |             |                |            |         |
+| Btse        |        | ✅          | ✅             |            |         |
+| Bybit       | ✅     | ✅          | ✅             |            |         |
+| Gateio      | ✅     | ✅          | ✅             |            |         |
+| Hyperliquid |        |             |                |            |         |
+| Kcex        |        |             |                |            |         |
+| Kraken      |        | ✅          | ✅             |            |         |
+| Kucoin      |        | ✅          | ✅             |            |         |
+| Mexc        | ✅     | ✅          | ✅             |            |         |
+| Okx         |        | ✅          | ✅             |            |         |
+| Weex        |        |             |                |            |         |
+| Xt          |        |             |                |            |         |
+
+---
+
+### 📖 Описание колонок
+
+- **Client** – Обертки над HTTP методами следующих разделов: market, order, position, account.
+- **Client Auth** – Поддержка авторизации и приватных эндпоинтов.
+- **Client Generic** – Универсальная функция для вызова не обернутых методов API.
+- **WS Manager** – Обертки над вебсокетами биржи.
+- **User WS** – Поддержка пользовательских вебсокетов.
+
+---
+
+## ✅ Статус реализации (Унифицированный интерфейс)
+
+| Exchange    | UniClient | UniWebsocketManager |
+|-------------|-----------|----------------------|
+| Binance     | ✅        | ✅                   |
+| Bitget      | ✅        |                      |
+| Bitrue      |           |                      |
+| Bitunix     |           |                      |
+| Btse        |           |                      |
+| Bybit       | ✅        |                      |
+| Gateio      | ✅        |                      |
+| Hyperliquid |           |                      |
+| Kcex        |           |                      |
+| Kraken      |           |                      |
+| Kucoin      |           |                      |
+| Mexc        | ✅        |                      |
+| Okx         | ✅        |                      |
+| Weex        |           |                      |
+| Xt          |           |                      |
+
+---
+
+## 🚀 Быстрый старт
+
+- Установка: `pip install unicex` или из исходников: `pip install -e .`
+- Библиотека полностью асинхронная. Примеры импорта:
+  - Сырые клиенты: `from unicex.binance import Client`
+  - Унифицированные клиенты: `from unicex.binance import UniClient`
+  - Вебсокет менеджеры: `from unicex.binance import WebsocketManager, UniWebsocketManager`
+
+Пример: получить последние цены через унифицированный клиент Binance
+
+```
+import asyncio
+from unicex.binance import UniClient
+
+
+async def main():
+    client = await UniClient.create()
+    prices = await client.last_price()
+    print(prices["BTCUSDT"])
+    await client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Пример: подписаться на трейды через унифицированный WS‑менеджер Bitget
+
+```
+import asyncio
+from unicex.bitget import UniWebsocketManager
+from unicex import TradeDict
+
+
+async def on_trade(msg: TradeDict):
+    print(msg)
+
+
+async def main():
+    uwm = UniWebsocketManager()
+    socket = uwm.trades(callback=on_trade, symbol="BTCUSDT")
+    await socket.start()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+---
+
+## 🧑‍💻 Блок для разработчика
+
+### 📋 Todo
+- Написать 1–2 примера
+- На фьючерсах OKX ticker24hr и klines возвращают объем в контрактах
+- Как реализовать типы в сырых клиентах? str | int | float?
+- в klines и futures_klines нужно дать возможность передавать строки, чтобы они не маппились автоматически. Либо расширить список таймфреймов
++ В mexc клиенте неправильные ссылки на документацию на фьючах
++ Доделать BitgetClient и проверить типы
++ Пересмотреть вопрос: должен ли быть адаптер интерфейсом?
++ Добавить overload к методам с `None, None`
++ Определить порядок полей, возвращаемых адаптером
++ Не делать .get в адаптере
++ нужно ли как-то изменять тикер в юни клиенте и ападетере?

unicex-0.4.0/README.md

@@ -0,0 +1,124 @@
+# Unified Crypto Exchange API
+
+`unicex` — асинхронная библиотека для работы с криптовалютными биржами, реализующая унифицированный интерфейс поверх «сырых» REST и WebSocket API разных бирж.
+
+## ✅ Статус реализации
+
+## ✅ Статус реализации
+
+| Exchange    | Client | Client Auth | Client Generic | WS Manager | User WS |
+|-------------|--------|-------------|----------------|------------|---------|
+| Binance     | ✅     | ✅          | ✅             | ✅         | ✅      |
+| Bitget      | ✅     | ✅          | ✅             | ✅         |         |
+| Bitrue      |        | ✅          | ✅             |            |         |
+| Bitunix     |        |             |                |            |         |
+| Btse        |        | ✅          | ✅             |            |         |
+| Bybit       | ✅     | ✅          | ✅             |            |         |
+| Gateio      | ✅     | ✅          | ✅             |            |         |
+| Hyperliquid |        |             |                |            |         |
+| Kcex        |        |             |                |            |         |
+| Kraken      |        | ✅          | ✅             |            |         |
+| Kucoin      |        | ✅          | ✅             |            |         |
+| Mexc        | ✅     | ✅          | ✅             |            |         |
+| Okx         |        | ✅          | ✅             |            |         |
+| Weex        |        |             |                |            |         |
+| Xt          |        |             |                |            |         |
+
+---
+
+### 📖 Описание колонок
+
+- **Client** – Обертки над HTTP методами следующих разделов: market, order, position, account.
+- **Client Auth** – Поддержка авторизации и приватных эндпоинтов.
+- **Client Generic** – Универсальная функция для вызова не обернутых методов API.
+- **WS Manager** – Обертки над вебсокетами биржи.
+- **User WS** – Поддержка пользовательских вебсокетов.
+
+---
+
+## ✅ Статус реализации (Унифицированный интерфейс)
+
+| Exchange    | UniClient | UniWebsocketManager |
+|-------------|-----------|----------------------|
+| Binance     | ✅        | ✅                   |
+| Bitget      | ✅        |                      |
+| Bitrue      |           |                      |
+| Bitunix     |           |                      |
+| Btse        |           |                      |
+| Bybit       | ✅        |                      |
+| Gateio      | ✅        |                      |
+| Hyperliquid |           |                      |
+| Kcex        |           |                      |
+| Kraken      |           |                      |
+| Kucoin      |           |                      |
+| Mexc        | ✅        |                      |
+| Okx         | ✅        |                      |
+| Weex        |           |                      |
+| Xt          |           |                      |
+
+---
+
+## 🚀 Быстрый старт
+
+- Установка: `pip install unicex` или из исходников: `pip install -e .`
+- Библиотека полностью асинхронная. Примеры импорта:
+  - Сырые клиенты: `from unicex.binance import Client`
+  - Унифицированные клиенты: `from unicex.binance import UniClient`
+  - Вебсокет менеджеры: `from unicex.binance import WebsocketManager, UniWebsocketManager`
+
+Пример: получить последние цены через унифицированный клиент Binance
+
+```
+import asyncio
+from unicex.binance import UniClient
+
+
+async def main():
+    client = await UniClient.create()
+    prices = await client.last_price()
+    print(prices["BTCUSDT"])
+    await client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Пример: подписаться на трейды через унифицированный WS‑менеджер Bitget
+
+```
+import asyncio
+from unicex.bitget import UniWebsocketManager
+from unicex import TradeDict
+
+
+async def on_trade(msg: TradeDict):
+    print(msg)
+
+
+async def main():
+    uwm = UniWebsocketManager()
+    socket = uwm.trades(callback=on_trade, symbol="BTCUSDT")
+    await socket.start()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+---
+
+## 🧑‍💻 Блок для разработчика
+
+### 📋 Todo
+- Написать 1–2 примера
+- На фьючерсах OKX ticker24hr и klines возвращают объем в контрактах
+- Как реализовать типы в сырых клиентах? str | int | float?
+- в klines и futures_klines нужно дать возможность передавать строки, чтобы они не маппились автоматически. Либо расширить список таймфреймов
++ В mexc клиенте неправильные ссылки на документацию на фьючах
++ Доделать BitgetClient и проверить типы
++ Пересмотреть вопрос: должен ли быть адаптер интерфейсом?
++ Добавить overload к методам с `None, None`
++ Определить порядок полей, возвращаемых адаптером
++ Не делать .get в адаптере
++ нужно ли как-то изменять тикер в юни клиенте и ападетере?

{unicex-0.1.18 → unicex-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ name = "unicex"
 # •	PATCH (x.y.Z) → увеличивается при багфиксе, который не ломает совместимость.
 # •	MINOR (x.Y.z) → увеличивается при добавлении новой функциональности, но без ломающих изменений (backward-compatible).
 # •	MAJOR (X.y.z) → увеличивается при изменениях, которые ломают обратную совместимость.
-version = "0.1.18"
+version = "0.4.0"
 
 description = "Unified Crypto Exchange API "
 readme = "README.md"
@@ -17,8 +17,6 @@ dependencies = [
     "aiohttp>=3.12.15",
     "loguru>=0.7.3",
     "orjson>=3.11.3",
-    "requests>=2.32.5",
-    "websocket-client>=1.8.0",
     "websockets>=15.0.1",
 ]
 
@@ -31,7 +29,5 @@ Readthedocs = "https://unicex.readthedocs.io/ru/latest/"
 dev = [
     "build>=1.3.0",
     "pre-commit>=4.3.0",
-    "sphinx>=8.2.3",
-    "sphinx-rtd-theme>=3.0.2",
     "twine>=6.2.0",
 ]

unicex-0.4.0/unicex/__init__.py

@@ -0,0 +1,255 @@
+"""unicex - библиотека для работы с криптовалютными биржами, реализующая унифицированный интерфейс для работы с различными криптовалютными биржами."""
+
+__all__ = [
+    # Mappers
+    "get_uni_client",
+    "get_uni_websocket_manager",
+    # Enums
+    "MarketType",
+    "Exchange",
+    "Timeframe",
+    "Side",
+    # Types
+    "KlineDict",
+    "AggTradeDict",
+    "TradeDict",
+    "TickerDailyDict",
+    "RequestMethod",
+    "LoggerLike",
+    # Interfaces
+    "IUniClient",
+    "IUniWebsocketManager",
+    # Base clients and websockets
+    "Websocket",
+    "BaseClient",
+    # Binance
+    "BinanceClient",
+    "BinanceUniClient",
+    "BinanceWebsocketManager",
+    "BinanceUniWebsocketManager",
+    "BinanceUserWebsocket",
+    # Bitget
+    "BitgetClient",
+    "BitgetUniClient",
+    "BitgetUniWebsocketManager",
+    "BitgetWebsocketManager",
+    "BitgetUserWebsocket",
+    # Bitrue
+    "BitrueClient",
+    "BitrueUniClient",
+    "BitrueUniWebsocketManager",
+    "BitrueWebsocketManager",
+    "BitrueUserWebsocket",
+    # Mexc
+    "MexcClient",
+    "MexcUniClient",
+    "MexcUniWebsocketManager",
+    "MexcWebsocketManager",
+    "MexcUserWebsocket",
+    # Bybit
+    "BybitClient",
+    "BybitUniClient",
+    "BybitUniWebsocketManager",
+    "BybitWebsocketManager",
+    "BybitUserWebsocket",
+    # Okx
+    "OkxClient",
+    "OkxUniClient",
+    "OkxUniWebsocketManager",
+    "OkxWebsocketManager",
+    "OkxUserWebsocket",
+    # Hyperliquid
+    "HyperliquidClient",
+    "HyperliquidUniClient",
+    "HyperliquidUniWebsocketManager",
+    "HyperliquidWebsocketManager",
+    "HyperliquidUserWebsocket",
+    # Gateio
+    "GateioClient",
+    "GateioUniClient",
+    "GateioUniWebsocketManager",
+    "GateioWebsocketManager",
+    "GateioUserWebsocket",
+    # Bitunix
+    "BitunixClient",
+    "BitunixUniClient",
+    "BitunixUniWebsocketManager",
+    "BitunixWebsocketManager",
+    "BitunixUserWebsocket",
+    # Btse
+    "BtseClient",
+    "BtseUniClient",
+    "BtseUniWebsocketManager",
+    "BtseWebsocketManager",
+    "BtseUserWebsocket",
+    # Kcex
+    "KcexClient",
+    "KcexUniClient",
+    "KcexUniWebsocketManager",
+    "KcexWebsocketManager",
+    "KcexUserWebsocket",
+    # Kraken
+    "KrakenClient",
+    "KrakenUniClient",
+    "KrakenUniWebsocketManager",
+    "KrakenWebsocketManager",
+    "KrakenUserWebsocket",
+    # Kucoin
+    "KucoinClient",
+    "KucoinUniClient",
+    "KucoinUniWebsocketManager",
+    "KucoinWebsocketManager",
+    "KucoinUserWebsocket",
+    # Weex
+    "WeexClient",
+    "WeexUniClient",
+    "WeexUniWebsocketManager",
+    "WeexWebsocketManager",
+    "WeexUserWebsocket",
+    # Xt
+    "XtClient",
+    "XtUniClient",
+    "XtUniWebsocketManager",
+    "XtWebsocketManager",
+    "XtUserWebsocket",
+]
+
+# ruff: noqa
+
+# abstract & base
+from ._abc import IUniClient, IUniWebsocketManager
+from ._base import BaseClient, Websocket
+
+# enums, mappers, types
+from .enums import Exchange, MarketType, Side, Timeframe
+from .mapper import get_uni_client, get_uni_websocket_manager
+from .types import (
+    AggTradeDict,
+    KlineDict,
+    LoggerLike,
+    RequestMethod,
+    TickerDailyDict,
+    TradeDict,
+)
+
+# exchanges
+
+from .binance import (
+    Client as BinanceClient,
+    UniClient as BinanceUniClient,
+    UniWebsocketManager as BinanceUniWebsocketManager,
+    UserWebsocket as BinanceUserWebsocket,
+    WebsocketManager as BinanceWebsocketManager,
+)
+
+from .bitget import (
+    Client as BitgetClient,
+    UniClient as BitgetUniClient,
+    UniWebsocketManager as BitgetUniWebsocketManager,
+    UserWebsocket as BitgetUserWebsocket,
+    WebsocketManager as BitgetWebsocketManager,
+)
+
+from .bitrue import (
+    Client as BitrueClient,
+    UniClient as BitrueUniClient,
+    UniWebsocketManager as BitrueUniWebsocketManager,
+    UserWebsocket as BitrueUserWebsocket,
+    WebsocketManager as BitrueWebsocketManager,
+)
+
+from .bitunix import (
+    Client as BitunixClient,
+    UniClient as BitunixUniClient,
+    UniWebsocketManager as BitunixUniWebsocketManager,
+    UserWebsocket as BitunixUserWebsocket,
+    WebsocketManager as BitunixWebsocketManager,
+)
+
+from .btse import (
+    Client as BtseClient,
+    UniClient as BtseUniClient,
+    UniWebsocketManager as BtseUniWebsocketManager,
+    UserWebsocket as BtseUserWebsocket,
+    WebsocketManager as BtseWebsocketManager,
+)
+
+from .bybit import (
+    Client as BybitClient,
+    UniClient as BybitUniClient,
+    UniWebsocketManager as BybitUniWebsocketManager,
+    UserWebsocket as BybitUserWebsocket,
+    WebsocketManager as BybitWebsocketManager,
+)
+
+from .gateio import (
+    Client as GateioClient,
+    UniClient as GateioUniClient,
+    UniWebsocketManager as GateioUniWebsocketManager,
+    UserWebsocket as GateioUserWebsocket,
+    WebsocketManager as GateioWebsocketManager,
+)
+
+from .hyperliquid import (
+    Client as HyperliquidClient,
+    UniClient as HyperliquidUniClient,
+    UniWebsocketManager as HyperliquidUniWebsocketManager,
+    UserWebsocket as HyperliquidUserWebsocket,
+    WebsocketManager as HyperliquidWebsocketManager,
+)
+
+from .kcex import (
+    Client as KcexClient,
+    UniClient as KcexUniClient,
+    UniWebsocketManager as KcexUniWebsocketManager,
+    UserWebsocket as KcexUserWebsocket,
+    WebsocketManager as KcexWebsocketManager,
+)
+
+from .kraken import (
+    Client as KrakenClient,
+    UniClient as KrakenUniClient,
+    UniWebsocketManager as KrakenUniWebsocketManager,
+    UserWebsocket as KrakenUserWebsocket,
+    WebsocketManager as KrakenWebsocketManager,
+)
+
+from .kucoin import (
+    Client as KucoinClient,
+    UniClient as KucoinUniClient,
+    UniWebsocketManager as KucoinUniWebsocketManager,
+    UserWebsocket as KucoinUserWebsocket,
+    WebsocketManager as KucoinWebsocketManager,
+)
+
+from .mexc import (
+    Client as MexcClient,
+    UniClient as MexcUniClient,
+    UniWebsocketManager as MexcUniWebsocketManager,
+    UserWebsocket as MexcUserWebsocket,
+    WebsocketManager as MexcWebsocketManager,
+)
+
+from .okx import (
+    Client as OkxClient,
+    UniClient as OkxUniClient,
+    UniWebsocketManager as OkxUniWebsocketManager,
+    UserWebsocket as OkxUserWebsocket,
+    WebsocketManager as OkxWebsocketManager,
+)
+
+from .weex import (
+    Client as WeexClient,
+    UniClient as WeexUniClient,
+    UniWebsocketManager as WeexUniWebsocketManager,
+    UserWebsocket as WeexUserWebsocket,
+    WebsocketManager as WeexWebsocketManager,
+)
+
+from .xt import (
+    Client as XtClient,
+    UniClient as XtUniClient,
+    UniWebsocketManager as XtUniWebsocketManager,
+    UserWebsocket as XtUserWebsocket,
+    WebsocketManager as XtWebsocketManager,
+)

{unicex-0.1.18/unicex/_abc/asyncio → unicex-0.4.0/unicex/_abc}/__init__.py

@@ -1,4 +1,7 @@
-__all__ = ["IUniClient", "IUniWebsocketManager"]
+__all__ = [
+    "IUniClient",
+    "IUniWebsocketManager",
+]
 
 from .uni_client import IUniClient
 from .uni_websocket_manager import IUniWebsocketManager