From 2f8db87c7536d6bc739a019b836633e7304e7784 Mon Sep 17 00:00:00 2001 From: Morty Space Date: Mon, 17 Feb 2020 19:16:57 +0200 Subject: [PATCH] Updated docs, updated symbols --- docs/source/guide.rst | 2 -- docs/source/index.rst | 32 ++++++++++++++++++++++++-------- docs/source/install.rst | 2 -- setup.py | 3 ++- src/cryptocom/exchange/enums.py | 8 ++++++++ 5 files changed, 34 insertions(+), 13 deletions(-) delete mode 100644 docs/source/guide.rst delete mode 100644 docs/source/install.rst diff --git a/docs/source/guide.rst b/docs/source/guide.rst deleted file mode 100644 index 2540431..0000000 --- a/docs/source/guide.rst +++ /dev/null @@ -1,2 +0,0 @@ -User's Guide -============ diff --git a/docs/source/index.rst b/docs/source/index.rst index 8ac443a..328f96e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,23 +8,31 @@ :caption: Contents: Home - install - guide api Welcome to cryptocom-exchange documentation! ============================================ -Get started with "Installation" and then get an overview with the User's guide with helpful examples. Also you can find tests with examples of trading and exchange data usage. -Full reference you can find in the API section. cryptocom-exchange depends on the aiohttp the documentation for this library can be found at: "link". +This package provides interfaces to access a https://crypto.com/exchange API. +Supports only **Python 3.7+** versions. +You can find tests with examples of trading and exchange data usage at +`github `_. +Full reference you can find in the API section. Quick-start =========== -- python3 -m venv venv (create virutalenv) -- source venv/bin/activate -- pip3 install cryptocom-exchange +Create virtual environment, activate, install -- create simple file hello_crypto.py with contents +.. code-block:: bash + + python3 -m venv venv + source venv/bin/activate + pip3 install cryptocom-exchange + +Userful examples +================ + +- Get historical data .. testcode:: @@ -41,6 +49,14 @@ Quick-start asyncio.run(main()) +- Watch latest candles live + +- Get orderbook + +- Buy or Sell with LIMIT or MARKET orders + +- Get trades and orders + Indices and tables ================== diff --git a/docs/source/install.rst b/docs/source/install.rst deleted file mode 100644 index 11e4437..0000000 --- a/docs/source/install.rst +++ /dev/null @@ -1,2 +0,0 @@ -Installation -============ diff --git a/setup.py b/setup.py index d1a7060..41bd451 100644 --- a/setup.py +++ b/setup.py @@ -52,7 +52,8 @@ setup( 'sphinx_rtd_theme', 'setuptools', 'wheel', - 'twine' + 'twine', + 'doc8' ] }, zip_safe=True diff --git a/src/cryptocom/exchange/enums.py b/src/cryptocom/exchange/enums.py index f0c898f..6f313cc 100644 --- a/src/cryptocom/exchange/enums.py +++ b/src/cryptocom/exchange/enums.py @@ -85,6 +85,7 @@ class Symbol(enum.Enum): .. data:: LTCBTC .. data:: EOSBTC .. data:: XLMBTC + .. data:: ATOMBTC .. data:: USDCUSDT .. data:: BTCUSDT .. data:: CROUSDT @@ -94,12 +95,15 @@ class Symbol(enum.Enum): .. data:: LTCUSDT .. data:: EOSUSDT .. data:: XLMUSDT + .. data:: ATOMUSDT .. data:: MCOCRO .. data:: ETHCRO .. data:: XRPCRO .. data:: LTCCRO .. data:: EOSCRO .. data:: XLMCRO + .. data:: ATOMCRO + .. data:: CROUSDC """ CROBTC = 'crobtc' @@ -109,6 +113,7 @@ class Symbol(enum.Enum): LTCBTC = 'ltcbtc' EOSBTC = 'eosbtc' XLMBTC = 'xlmbtc' + ATOMBTC = 'atombtc' USDCUSDT = 'usdcusdt' BTCUSDT = 'btcusdt' CROUSDT = 'crousdt' @@ -118,12 +123,15 @@ class Symbol(enum.Enum): LTCUSDT = 'ltcusdt' EOSUSDT = 'eosusdt' XLMUSDT = 'xlmusdt' + ATOMUSDT = 'atomusdt' MCOCRO = 'mcocro' ETHCRO = 'ethcro' XRPCRO = 'xrpcro' LTCCRO = 'ltccro' EOSCRO = 'eoscro' XLMCRO = 'xlmcro' + ATOMCRO = 'atomcro' + CROUSDC = 'crousdc' class Depth(enum.Enum):