Merge pull request #1 from xbklairith/feature/rest-client

Feature/rest client

Author: xbklairith

.flake8

@@ -0,0 +1,26 @@
+[flake8]
+max-line-length = 99
+enable-extensions = G
+extend-ignore =
+    G200, G202,
+    # black adds spaces around ':'
+    E203,
+    # E501 line too long (let black handle line length)
+    E501
+    # B305 `.next()` is not a thing on Python 3
+    B305
+
+
+per-file-ignores =
+    # E402 module level import not at top of file
+    # B011 Do not call assert False since python -O removes these calls
+    # F405 'Foo' may be undefined, or defined from star imports
+    # E741 ambiguous variable name
+    # B007 Loop control variable 'foo' not used within the loop body
+    # F403 'from foo import *' used; unable to detect undefined names
+    # B001 Do not use bare `except:`
+    # E722 do not use bare 'except'
+    # E731 do not assign a lambda expression, use a def
+    # F811 redefinition of unused 'foo' from line XXX
+    # F841 local variable 'foo' is assigned to but never used
+    tests/*: E402, B011, F405, E741, B007, F403, B001, E722, E731, F811, F841

.gitignore

@@ -158,3 +158,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+test.ipynb

README.md

@@ -1,2 +1,53 @@
 # bitkub-python
-A Python wrapper for Bitkub API
+A Python client for Bitkub API 
+
+## ⚠️ Disclaimer: This is not an official Bitkub library. Use at your own risk. 
+- This library is not guaranteed to be up-to-date with the latest Bitkub API.
+- Before using the library, please check the [API documentation](https://github.com/bitkub/bitkub-official-api-docs) to be informed about the latest updated or possible bugs.
+
+
+## Features
+- Trading support
+- General market data and account information
+- Handling of authentication  
+- Deposit and withdrawal of funds
+
+
+
+
+
+## Getting Started
+
+[Generate an API Key](https://www.bitkub.com/en/api-management) and assign permissions.
+
+### Installation
+```bash
+pip install bitkub-python
+```
+
+
+### Usage
+```python
+from bitkub import Client
+client = Client("apikey" , "apisecret")
+
+orderbooks = client.fetch_depth(symbol='THB_ETH', limit=10)
+
+# create order
+order = client.create_order_buy(symbol='USDT_THB', amount=10, rate=30)
+
+# cancel order
+client.cancel_order(order_id=order['id'])
+
+# fetch open orders
+client.fetch_open_orders(symbol='BTC_THB')
+
+```
+
+
+## Buy me a coffee ☕
+if you find this library useful, please consider buying me a coffee.
+- [Buy me a coffee ☕](https://www.buymeacoffee.com/xbklairith)
+
+Ref : 
+- [bitkub-official-api-doc](https://github.com/bitkub/bitkub-official-api-docs)

bitkub/__init__.py

@@ -1,5 +1,10 @@
-"""An unofficial Python wrapper for Bitkub API
+"""An unofficial Python client library for Bitkub API
 
 """
 
 __version__ = "0.0.1"
+
+from .client import Client  # noqa: F401
+from .exception import BitkubException  # noqa: F401
+
+__all__ = ["Client", "BitkubException"]