Merge pull request #132 from yzh-pelle/update-2024-11

feat(kucoin): upgrade spot, add futures and asyncClient

Author: carlosmiei

.github/workflows/python-app.yml

@@ -4,37 +4,73 @@
 name: Python application
 
 on:
+  workflow_dispatch:
   push:
-    branches: [ "develop" ]
+    branches: [ main, master ]
   pull_request:
-    branches: [ "develop" ]
+    branches: [ main, master ]
 
 permissions:
   contents: read
 
 jobs:
-  build:
-
+  lint:
     runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+    - name: Install Ruff
+      run: pip install ruff
+    - name: Lint code with Ruff
+      run: ruff check --output-format=github --target-version=py39 .
+    - name: Check code formatting with Ruff
+      run: ruff format --check .
+      continue-on-error: true
 
+  build:
+    needs: lint
+    runs-on: ubuntu-latest
+    env:
+      PROXY: "http://51.83.140.52:16301"
+    strategy:
+      max-parallel: 1
+      matrix:
+        python: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+    - name: Checking env
+      run: |
+        echo "PROXY: $PROXY"
+        env
+    - name: Set up Python ${{ matrix.python }}
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.10"
+        python-version: ${{ matrix.python }}
+        cache: 'pip'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest
+        pip install pytest pytest-cov pyright tox
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
-      run: |
-        pytest
+    # - name: Type check with pyright
+    #   run: pyright
+    - name: Test with tox
+      run: tox -e py
+    - name: Coveralls Parallel
+      uses: coverallsapp/github-action@v2
+      with:
+        flag-name: run-${{ join(matrix.*, '-') }}
+        parallel: true
+  finish:
+    needs: build
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true

README.rst

@@ -2,8 +2,6 @@
 Welcome to python-kucoin v2.1.3
 ===============================
 
-Last Updated 4th Oct 2021
-
 .. image:: https://img.shields.io/pypi/v/python-kucoin.svg
     :target: https://pypi.python.org/pypi/python-kucoin
 
@@ -22,7 +20,7 @@ Last Updated 4th Oct 2021
 .. image:: https://img.shields.io/pypi/pyversions/python-kucoin.svg
     :target: https://pypi.python.org/pypi/python-kucoin
 
-This is an unofficial Python wrapper for the `Kucoin exchanges REST and Websocket API v2 <https://docs.kucoin.com/>`_.
+This is an unofficial Python wrapper for the `Kucoin exchanges REST and Websocket API v3 <https://docs.kucoin.com/>`_.
 I am in no way affiliated with `Kucoin <https://www.kucoin.com/ucenter/signup?rcode=E5wkqe>`_, use at your own risk.
 
 
@@ -35,17 +33,20 @@ Source code
 Documentation
   https://python-kucoin.readthedocs.io/en/latest/
 
-Blog with examples
-  https://sammchardy.github.io
+Examples
+  https://github.com/sammchardy/python-kucoin/tree/master/examples
 
 
 Features
 --------
 
 - Implementation of REST endpoints
+- Spot and Futures
+- Sync and Async suport
 - Simple handling of authentication
 - Response exception handling
 - Implement websockets (note only python3.5+)
+- Proxy support
 
 TODO
 ----
@@ -57,28 +58,22 @@ Quick Start
 
 Register an account with `Kucoin <https://www.kucoin.com/ucenter/signup?rcode=E42cWB>`_.
 
-To test on the Sandbox register with `Kucoin Sandbox <https://sandbox.kucoin.com/ucenter/signup?rcode=ewcefH>`_.
-
-`Generate an API Key <https://kucoin.com/account/api>`_
-or `Generate an API Key in Sandbox <https://sandbox.kucoin.com/account/api>`_ and enable it.
+`Generate an API Key <https://kucoin.com/account/api>`_.
 
 .. code:: bash
 
     pip install python-kucoin
 
 .. code:: python
 
-    from kucoin.client import Client
+    from kucoin import Client
 
     api_key = '<api_key>'
     api_secret = '<api_secret>'
     api_passphrase = '<api_passphrase>'
 
     client = Client(api_key, api_secret, api_passphrase)
 
-    # or connect to Sandbox
-    # client = Client(api_key, api_secret, api_passphrase, sandbox=True)
-
     # get currencies
     currencies = client.get_currencies()
 
@@ -97,6 +92,23 @@ or `Generate an API Key in Sandbox <https://sandbox.kucoin.com/account/api>`_ an
     # get list of active orders
     orders = client.get_active_orders('KCS-BTC')
 
+
+Async
+-----
+
+.. code:: python
+
+    from kucoin import AsyncClient
+
+    api_key = '<api_key>'
+    api_secret = '<api_secret>'
+    api_passphrase = '<api_passphrase>'
+
+    client = AsyncClient(api_key, api_secret, api_passphrase)
+
+    # get currencies
+    currencies = await client.get_currencies()
+
 Websockets
 ----------
 
@@ -199,5 +211,6 @@ For more `check out the documentation <https://python-kucoin.readthedocs.io/en/l
 Other Exchanges
 ---------------
 
-If you use `Binance <https://www.binance.com/?ref=10099792>`_ check out my `python-binance <https://github.com/sammchardy/python-binance>`_ library.
+- If you use `Binance <https://accounts.binance.com/register?ref=PGDFCE46>`_ check out my `python-binance <https://github.com/sammchardy/python-binance>`_ library.
+- Check out `CCXT <https://github.com/ccxt/ccxt>`_ for more than 100 crypto exchanges with a unified trading API.
 

build/generateAsyncClient.ts

@@ -0,0 +1,77 @@
+import fs from 'fs'
+
+const SOURSE_FILE_NAME = './kucoin/client.py'
+const TARGET_FILE_NAME = './kucoin/async_client.py'
+const METHOD_DEFINITION_MATCH = /def\s(\w+)/
+const METHOD_CALL_MATCH = /self\.(\w+)\(/
+const DEFINITION_PREFIX = 'def'
+const ASYNC_DEFINITION_PREFIX = 'async def'
+const CALL_PREFIX = 'self.'
+const ASYNC_CALL_PREFIX = 'await self.'
+const SPECIAL_REPLACEMENTS = {} // Add special replacements here
+const SPECIAL_REPLACEMENTS_KEYS = Object.keys (SPECIAL_REPLACEMENTS)
+
+function replaceKeywords (data) {
+    const lines = data.split ('\n')
+    const asyncClient = [ ] as any
+    for (let line of lines) {
+        let specialMatch = false
+        for (let key of SPECIAL_REPLACEMENTS_KEYS) {
+            if (line.includes (key)) {
+                asyncClient.push (line.replace (key, SPECIAL_REPLACEMENTS[key]))
+                delete SPECIAL_REPLACEMENTS[key]
+                specialMatch = true
+                break
+            }
+        }
+        if (specialMatch) {
+            continue
+        }
+        if (line.startsWith('class Client(BaseClient):')) {
+            asyncClient.push ('class AsyncClient(AsyncClientBase):')
+            continue
+        }
+        if (line.startsWith('from .base_client import BaseClient')) {
+            asyncClient.push ('from .async_client_base import AsyncClientBase')
+            continue
+        }
+        const methodDefinition = line.match (METHOD_DEFINITION_MATCH)
+        const methodCall = line.match (METHOD_CALL_MATCH)
+        const match = methodDefinition || methodCall
+        if (match) {
+            const methodName = match[1]
+            if (methodName !== '__init__') {
+                if (methodDefinition) {
+                    line = line.replace (DEFINITION_PREFIX, ASYNC_DEFINITION_PREFIX)
+                } else if (methodCall) {
+                    line = line.replace (CALL_PREFIX, ASYNC_CALL_PREFIX)
+                }
+            }
+            // let replacementRequired = true
+            // if (methodName.startsWith ('_')) {
+            //     replacementRequired = false
+            // }
+
+        }
+        asyncClient.push (line)
+    }
+    return asyncClient.join ('\n')
+}
+
+function main () {
+    fs.readFile (SOURSE_FILE_NAME, 'utf8', (err, data) => {
+        if (err) {
+            console.error (err)
+            return
+        }
+        const asyncClient = replaceKeywords (data)
+        fs.writeFile (TARGET_FILE_NAME, asyncClient, (err) => {
+            if (err) {
+                console.error (err)
+                return
+            }
+            console.log (TARGET_FILE_NAME + ' file is generated')})
+        })
+}
+
+main ()

examples/create_order_async.py

@@ -0,0 +1,22 @@
+
+import os
+import sys
+import asyncio
+
+root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+sys.path.append(root)
+
+from kucoin import AsyncClient
+
+api_key = os.environ.get('KUCOIN_APIKEY')
+api_secret = os.environ.get('KUCOIN_SECRET')
+api_passphrase = os.environ.get('KUCOIN_PASSWORD')
+
+async def main():
+    client = AsyncClient(api_key, api_secret, api_passphrase)
+
+    order = await client.create_market_order('LTC-USDT', AsyncClient.SIDE_SELL, size=0.1)
+
+    print(order)
+
+asyncio.run(main())

kucoin/__init__.py

@@ -4,4 +4,14 @@
 
 """
 
-__version__ = '2.1.3'
+__version__ = "2.1.3"
+
+from kucoin.client import Client  # noqa
+from kucoin.async_client import AsyncClient  # noqa
+
+from kucoin.exceptions import (
+    KucoinAPIException,  # noqa
+    KucoinRequestException,  # noqa
+    MarketOrderException,  # noqa
+    LimitOrderException,  # noqa
+)