Merge pull request #1 from sometastycake/release_v0.0.1

Release v0.0.1

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - 'release_*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r test-requirements.txt
+      - name: tests
+        run: |
+          export PYTHONPATH=$PWD && pytest
+      - name: mypy
+        run: |
+          pip install mypy
+          mypy .
+      - name: flake8
+        run: |
+          pip install flake8
+          flake8 --benchmark .
+      - name: bandit
+        run: |
+          pip install bandit
+          bandit -r asynchuobi/

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [v0.0.1 (2023-01-06)](https://github.com/sometastycake/asynchuobi/releases/tag/v0.0.1)
+
+### Added
+
+- Market API
+- Account API
+- Algo API
+- Trading API
+- Wallet API
+- Margin API
+- Generic API
+- Subuser API
+- Websocket
+  - Retrieving market data
+  - Retrieving account data

README.md

@@ -1 +1,247 @@
-# python-huobi-client
+# Unofficial asynchronous python client for Huobi
+
+[![CI](https://github.com/sometastycake/asynchuobi/actions/workflows/ci.yml/badge.svg)](https://github.com/sometastycake/asynchuobi/actions/workflows/ci.yml)
+[![Python: versions](
+https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)]()
+
+## Official documentation
+[Documentation](https://huobiapi.github.io/docs/spot/v1/en/#change-log)
+
+## Install
+
+```bash
+pip install asynchuobi
+```
+
+## Generic API
+
+```python
+from asynchuobi.api.clients.generic import GenericHuobiClient
+
+
+async def main():
+    async with GenericHuobiClient() as client:
+        current_timestamp = await client.get_current_timestamp()
+        trading_symbols = await client.get_all_supported_trading_symbols()
+        system_status = await client.get_system_status()
+```
+
+## Market API
+
+```python
+from asynchuobi.api.clients.market import MarketHuobiClient
+from asynchuobi.enums import CandleInterval
+
+
+async def main():
+    async with MarketHuobiClient() as client:
+        candles = await client.get_candles('btcusdt', CandleInterval.min_1)
+        orderbook = await client.get_market_depth('btcusdt')
+        recent_trades = await client.get_most_recent_trades('btcusdt')
+```
+
+## Subuser API
+
+```python
+from asynchuobi.api.clients.subuser import SubUserHuobiClient
+from asynchuobi.enums import ApiKeyPermission
+
+
+async def main():
+    async with SubUserHuobiClient(
+        access_key='access_key',
+        secret_key='secret_key',
+    ) as client:
+        subusers = await client.get_sub_users_list()
+        for subuser in subusers['data']:
+            keys = await client.api_key_query(subuser['uid'])
+            status = await client.get_sub_user_status(subuser['uid'])
+            balance = await client.get_account_balance_of_sub_user(subuser['uid'])
+            api_key = await client.sub_user_api_key_creation(
+                sub_uid=subuser['uid'],
+                note='Test api',
+                permissions=[ApiKeyPermission.readOnly, ApiKeyPermission.trade],
+            )
+```
+
+## Wallet API
+
+```python
+from asynchuobi.api.clients.wallet import WalletHuobiClient
+
+
+async def main():
+    async with WalletHuobiClient(
+        access_key='access_key',
+        secret_key='secret_key',
+    ) as client:
+        deposit_address = await client.query_deposit_address('usdt')
+        withdraw_address = await client.query_withdraw_address('usdt')
+        withdraw_response = await client.create_withdraw_request(
+            address='address',
+            currency='usdt',
+            amount=10
+        )
+```
+
+## Account API
+
+```python
+from asynchuobi.api.clients.account import AccountHuobiClient
+from asynchuobi.enums import AccountTypeCode, Sort
+
+
+async def main():
+    async with AccountHuobiClient(
+        access_key='access_key',
+        secret_key='secret_key',
+    ) as client:
+        accounts = await client.accounts()
+        for account in accounts['data']:
+            balances = await client.account_balance(account_id=account['id'])
+            history = await client.get_account_history(
+                account_id=account['id'],
+                currency='usdt',
+                transact_types=['deposit', 'withdraw'],
+                sorting=Sort.desc,
+            )
+
+        for account_type in (AccountTypeCode.spot, AccountTypeCode.flat):
+            total_valuation = await client.get_total_valuation_of_platform_assets(
+                account_type_code=account_type,
+                valuation_currency='BTC',
+            )
+```
+
+## Orders API
+
+```python
+from asynchuobi.api.clients.order import OrderHuobiClient
+from asynchuobi.enums import OrderType
+
+async def main():
+    async with OrderHuobiClient(
+            access_key='access_key',
+            secret_key='secret_key'
+    ) as client:
+        response = await client.new_order(
+            account_id=account_id,
+            symbol='dogeusdt',
+            order_type=OrderType.buy_limit,
+            amount=20,
+            price=0.0660,
+        )
+        if response['status'] == 'ok':
+            order_id = response['data']
+            cancelling = await client.cancel_order(
+                order_id=order_id,
+            )
+
+        active_orders = await client.get_all_open_orders()
+        order_detail = await client.get_order_detail_by_client_order_id(
+            client_order_id=client_order_id,
+        )
+```
+
+## Margin API
+
+```python
+from asynchuobi.api.clients.margin import MarginHuobiClient
+
+
+async def main():
+    async with MarginHuobiClient(
+        access_key='access_key',
+        secret_key='secret_key',
+    ) as client:
+        cross_margin_balance = await client.get_balance_of_cross_margin_account()
+        isolated_margin_balance = await client.get_balance_of_isolated_margin_account(
+            symbol='btcusdt',
+        )
+```
+
+
+## WebSocket
+
+Client supports retrieving information about market data, such as candles, orderbook, trade details.
+
+### Usage
+
+```python
+from asynchuobi.enums import CandleInterval
+from asynchuobi.ws.ws_client import WSHuobiMarket
+
+
+async def main():
+    async with WSHuobiMarket() as ws:
+        await ws.candlestick('btcusdt', CandleInterval.min_1).sub()
+        await ws.market_stats('btcusdt').sub()
+        await ws.market_ticker_info('btcusdt').sub()
+        await ws.orderbook('btcusdt').sub()
+        async for message in ws:
+            ...
+```
+
+You can define callbacks which will called when message was received from websocket
+
+```python
+from typing import Dict
+
+from asynchuobi.exceptions import WSHuobiError
+from asynchuobi.ws.ws_client import WSHuobiMarket
+
+
+def callback(msg: Dict):
+    print(msg)
+
+
+def error(e: WSHuobiError):
+    print(e)
+
+
+async def orderbook():
+    async with WSHuobiMarket() as ws:
+        await ws.orderbook('btcusdt').sub(callback=callback)
+        await ws.run_with_callbacks(error_callback=error)
+```
+
+You can also define async callback
+
+### Retrieving information about account balance changing and about orders
+
+Authentication is required
+
+```python
+from asynchuobi.ws.ws_client import WSHuobiAccount
+
+
+async def main():
+    async with WSHuobiAccount('access_key', 'secret_key') as ws:
+        await ws.subscribe_account_change()
+        await ws.subscribe_order_updates('btcusdt')
+        async for message in ws:
+            ...
+```
+
+With callbacks
+
+```python
+from asynchuobi.ws.ws_client import WSHuobiAccount
+from asynchuobi.exceptions import WSHuobiError
+
+
+def callback(message: dict):
+    print(message)
+
+
+def error(e: WSHuobiError):
+    print(e)
+
+
+async def main():
+    async with WSHuobiAccount('access_key', 'secret_key') as ws:
+        await ws.subscribe_account_change(
+            callback=callback,
+        )
+        await ws.run_with_callbacks(error_callback=error)
+```

asynchuobi/__init__.py

@@ -0,0 +1,2 @@
+__version__ = '0.0.1'
+__author__ = 'Mike M'