code factor for v3.0.0 (#31)

* code factor for v3.0.0

Author: 2pd

.github/workflows/pythonpackage.yml

@@ -0,0 +1,36 @@
+name: Python package
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+      - rc-**
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/requirements-test.txt
+    - name: Run black to review standard code format
+      run: |
+        # Checks if need to reformat files
+        black --check --diff .
+    - name: Run flake8 to check specific rules not covered by black
+      run: |
+        flake8 . --statistics

.github/workflows/release.yaml

@@ -0,0 +1,27 @@
+name: Release Distributables
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  build-n-upload:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+    - run: pip install wheel
+    - name: Build new distributables
+      run: python setup.py sdist bdist_wheel
+    - name: Upload distributables to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+    - name: Post release cleaning
+      run: |
+        python setup.py clean --all
+        rm dist/*

CHANGELOG.md

@@ -1,5 +1,5 @@
 # Changelog
 
-## Unreleased
+## 3.0.0 - 2022-05-26
 
-## Released
+- Refactor the connector

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [2020]
+Copyright (c) [2022]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -19,23 +19,23 @@ This is a lightweight library that works as a connector to [Binance Futures publ
 pip install binance-futures-connector
 ```
 
-## Documentation
-- USDT-M Futures: https://github.com/Binance-docs/binance-futures-connector-python/wiki/USDT-M-Futures
-- COIN-M Futures: https://github.com/Binance-docs/binance-futures-connector-python/wiki/COIN-M-Futures
 
 ## RESTful APIs
 
 Usage examples:
 ```python
-from binance.futures import Futures 
 
-client = Futures()
-print(client.time())
+from binance.cm_futures import CMFutures
+
+cm_futures_client = CMFutures()
+
+# get server time
+print(cm_futures_client.time())
 
-client = Futures(key='<api_key>', secret='<api_secret>')
+cm_futures_client = CMFutures(key='<api_key>', secret='<api_secret>')
 
 # Get account information
-print(client.account())
+print(cm_futures_client.account())
 
 # Post a new order
 params = {
@@ -47,7 +47,7 @@ params = {
     'price': 59808
 }
 
-response = client.new_order(**params)
+response = cm_futures_client.new_order(**params)
 print(response)
 ```
 Please find `examples` folder to check for more endpoints.
@@ -78,10 +78,10 @@ It defaults to `5000` (milliseconds) and can be any value lower than `60000`(mil
 Anything beyond the limit will result in an error response from Binance server.
 
 ```python
-from binance.futures import Futures as Client
+from binance.cm_futures import CMFutures
 
-client = Client(key, secret)
-response = client.query_order('BTCUSDT', orderId=11, recvWindow=10000)
+cm_futures_client = CMFutures(key='<api_key>', secret='<api_secret>')
+response = cm_futures_client.query_order('BTCUSDT', orderId=11, recvWindow=10000)
 ```
 
 ### Timeout
@@ -91,20 +91,20 @@ Please remember the value as it won't be shown in error message _no bytes have b
 By default, `timeout` is None. Hence, requests do not time out.
 
 ```python
-from binance.futures import Futures as Client
+from binance.cm_futures import CMFutures
 
-client= Client(timeout=1)
+client= CMFutures(timeout=1)
 ```
 
 ### Proxy
 proxy is supported
 
 ```python
-from binance.futures import Futures as Client
+from binance.cm_futures import CMFutures
 
 proxies = { 'https': 'http://1.2.3.4:8080' }
 
-client= Client(proxies=proxies)
+client= CMFutures(proxies=proxies)
 ```
 
 ### Response Metadata
@@ -113,15 +113,15 @@ The Binance API server provides weight usages in the headers of each response.
 You can display them by initializing the client with `show_limit_usage=True`:
 
 ```python
-from binance.futures import Futures as Client
+from binance.cm_futures import CMFutures
 
-client = Client(show_limit_usage=True)
+client = CMFutures(show_limit_usage=True)
 print(client.time())
 ```
 returns:
 
 ```python
-{'data': {'serverTime': 1587990847650}, 'limit_usage': {'x-mbx-used-weight': '31', 'x-mbx-used-weight-1m': '31'}}
+{'limit_usage': {'x-mbx-used-weight-1m': '1'}, 'data': {'serverTime': 1653563092778}}
 ```
 You can also display full response metadata to help in debugging:
 
@@ -158,12 +158,13 @@ There are 2 types of error returned from the library:
 ## Websocket
 
 ```python
-from binance.websocket.futures.websocket_client import FuturesWebsocketClient as WebsocketClient
+import time
+from binance.websocket.cm_futures.websocket_client import CMFuturesWebsocketClient
 
 def message_handler(message):
     print(message)
 
-ws_client = WebsocketClient()
+ws_client = CMFuturesWebsocketClient()
 ws_client.start()
 
 ws_client.mini_ticker(
@@ -178,7 +179,11 @@ ws_client.instant_subscribe(
     callback=message_handler,
 )
 
+time.sleep(10)
+
+print("closing ws connection")
 ws_client.stop()
+
 ```
 More websocket examples are available in the `examples` folder
 
@@ -187,3 +192,5 @@ More websocket examples are available in the `examples` folder
 Once connected, the websocket server sends a ping frame every 3 minutes and requires a response pong frame back within
 a 10 minutes period. This package handles the pong responses automatically.
 
+## License
+MIT

binance/__version__.py

@@ -1 +1 @@
-__version__ = "1.5.0"
+__version__ = "3.0.0"

binance/api.py

@@ -1,5 +1,3 @@
-import sys
-
 import hmac
 import json
 import logging
@@ -145,7 +143,7 @@ def send_request(self, http_method, url_path, payload=None, special=False):
         return data
 
     def _prepare_params(self, params, special=False):
-        return encoded_string(cleanNoneValue(params),special)
+        return encoded_string(cleanNoneValue(params), special)
 
     def _get_sign(self, data):
         m = hmac.new(self.secret.encode("utf-8"), data.encode("utf-8"), hashlib.sha256)

binance/cm_futures/__init__.py

@@ -0,0 +1,68 @@
+from binance.api import API
+
+
+class CMFutures(API):
+    def __init__(self, key=None, secret=None, **kwargs):
+        if "base_url" not in kwargs:
+            kwargs["base_url"] = "https://dapi.binance.com"
+        super().__init__(key, secret, **kwargs)
+
+    # MARKETS
+    from binance.cm_futures.market import ping
+    from binance.cm_futures.market import time
+    from binance.cm_futures.market import exchange_info
+    from binance.cm_futures.market import depth
+    from binance.cm_futures.market import trades
+    from binance.cm_futures.market import historical_trades
+    from binance.cm_futures.market import agg_trades
+    from binance.cm_futures.market import klines
+    from binance.cm_futures.market import continuous_klines
+    from binance.cm_futures.market import index_price_klines
+    from binance.cm_futures.market import mark_price_klines
+    from binance.cm_futures.market import mark_price
+    from binance.cm_futures.market import funding_rate
+    from binance.cm_futures.market import ticker_24hr_price_change
+    from binance.cm_futures.market import ticker_price
+    from binance.cm_futures.market import book_ticker
+    from binance.cm_futures.market import open_interest
+    from binance.cm_futures.market import open_interest_hist
+    from binance.cm_futures.market import top_long_short_account_ratio
+    from binance.cm_futures.market import top_long_short_position_ratio
+    from binance.cm_futures.market import long_short_account_ratio
+    from binance.cm_futures.market import taker_long_short_ratio
+    from binance.cm_futures.market import basis
+
+    # ACCOUNT(including orders and trades)
+    from binance.cm_futures.account import change_position_mode
+    from binance.cm_futures.account import get_position_mode
+    from binance.cm_futures.account import new_order
+    from binance.cm_futures.account import modify_order
+    from binance.cm_futures.account import new_batch_order
+    from binance.cm_futures.account import modify_batch_order
+    from binance.cm_futures.account import order_modify_history
+    from binance.cm_futures.account import query_order
+    from binance.cm_futures.account import cancel_order
+    from binance.cm_futures.account import cancel_open_orders
+    from binance.cm_futures.account import cancel_batch_order
+    from binance.cm_futures.account import countdown_cancel_order
+    from binance.cm_futures.account import get_open_orders
+    from binance.cm_futures.account import get_orders
+    from binance.cm_futures.account import get_all_orders
+    from binance.cm_futures.account import balance
+    from binance.cm_futures.account import account
+    from binance.cm_futures.account import change_leverage
+    from binance.cm_futures.account import change_margin_type
+    from binance.cm_futures.account import modify_isolated_position_margin
+    from binance.cm_futures.account import get_position_margin_history
+    from binance.cm_futures.account import get_position_risk
+    from binance.cm_futures.account import get_account_trades
+    from binance.cm_futures.account import get_income_history
+    from binance.cm_futures.account import leverage_brackets
+    from binance.cm_futures.account import adl_quantile
+    from binance.cm_futures.account import force_orders
+    from binance.cm_futures.account import commission_rate
+
+    # STREAMS
+    from binance.cm_futures.data_stream import new_listen_key
+    from binance.cm_futures.data_stream import renew_listen_key
+    from binance.cm_futures.data_stream import close_listen_key