Updated docs, updated symbols

api-breakage
Morty Space 6 years ago
parent 408f990531
commit 2f8db87c75
  1. 2
      docs/source/guide.rst
  2. 32
      docs/source/index.rst
  3. 2
      docs/source/install.rst
  4. 3
      setup.py
  5. 8
      src/cryptocom/exchange/enums.py

@ -1,2 +0,0 @@
User's Guide
============

@ -8,23 +8,31 @@
:caption: Contents:
Home <self>
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 <https://github.com/goincrypto/cryptocom-exchange/tree/master/tests>`_.
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
==================

@ -1,2 +0,0 @@
Installation
============

@ -52,7 +52,8 @@ setup(
'sphinx_rtd_theme',
'setuptools',
'wheel',
'twine'
'twine',
'doc8'
]
},
zip_safe=True

@ -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):

Loading…
Cancel
Save