Skip to content

Commit e8f73fa

Browse files
gbecedgbeced
committed
Docs.
1 parent 75eadde commit e8f73fa

9 files changed

Lines changed: 58 additions & 5 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
### Features
66

7+
* [CCXT](https://docs.ccxt.com) integration.
78
* `fees.Percentage` now supports charging fees in base currency.
89
* Both `BacktestingDispatcher` and `RealtimeDispatcher` now support `subscribe_event_loop_started` to register handlers that are called once when the dispatch loop starts.
910

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
## Key Features
1212

1313
* Backtesting exchange so you can try your trading strategies before using real funds.
14-
* Live trading at [Binance](https://www.binance.com/) and [Bitstamp](https://www.bitstamp.net/) crypto currency exchanges.
14+
* Live trading at [Binance](https://www.binance.com/), [Bitstamp](https://www.bitstamp.net/) and 100+ crypto currency exchanges via [CCXT](https://docs.ccxt.com) integration.
1515
* Asynchronous I/O and event driven.
1616

1717
## Getting Started
1818

1919
### Installation
2020

2121
```
22-
$ pip install basana[charts]
22+
$ pip install basana[charts,ccxt]
2323
```
2424

2525
The examples use [TALIpp](https://github.com/nardew/talipp) for the technical indicators, pandas, statsmodels and also [Textual](https://textual.textualize.io/) if you want to run the Binance order book mirror.

‎docs/api.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,7 @@ API Reference
2323
bitstamp_order_book
2424
bitstamp_orders
2525
bitstamp_trades
26+
ccxt_exchange
27+
ccxt_order_book
28+
ccxt_orders
29+
ccxt_trades

‎docs/ccxt_exchange.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
basana.external.ccxt.exchange
2+
=============================
3+
4+
.. module:: basana.external.ccxt.exchange
5+
6+
.. autoclass:: basana.external.ccxt.exchange.Exchange
7+
:members:
8+
.. autoclass:: basana.external.ccxt.exchange.Balance
9+
:members:
10+
.. autoclass:: basana.external.ccxt.exchange.CreatedOrder
11+
:members:
12+
.. autoclass:: basana.external.ccxt.exchange.OrderInfo
13+
:members:
14+
.. autoclass:: basana.external.ccxt.exchange.CanceledOrder
15+
:members:

‎docs/ccxt_order_book.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
basana.external.ccxt.order_book
2+
===============================
3+
4+
.. module:: basana.external.ccxt.order_book
5+
6+
.. autoclass:: basana.external.ccxt.order_book.PartialOrderBookEvent
7+
:show-inheritance:
8+
:members:
9+
.. autoclass:: basana.external.ccxt.order_book.PartialOrderBook
10+
:members:
11+
.. autoclass:: basana.external.ccxt.order_book.Entry
12+
:members:

‎docs/ccxt_orders.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
basana.external.ccxt.orders
2+
=============================
3+
4+
.. module:: basana.external.ccxt.orders
5+
6+
.. autoclass:: basana.external.ccxt.orders.OrderEvent
7+
:show-inheritance:
8+
:members:
9+
.. autoclass:: basana.external.ccxt.orders.Order
10+
:members:

‎docs/ccxt_trades.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
basana.external.ccxt.trades
2+
=============================
3+
4+
.. module:: basana.external.ccxt.trades
5+
6+
.. autoclass:: basana.external.ccxt.trades.TradeEvent
7+
:show-inheritance:
8+
:members:
9+
.. autoclass:: basana.external.ccxt.trades.Trade
10+
:members:

‎docs/index.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ The framework has 3 main components:
1212

1313
* The core, where basic abstractions like events, event sources and the event dispatcher live.
1414
* A backtesting exchange that you can use to validate your strategies before using real money.
15-
* External integrations, where you'll find support for live trading at `Binance <https://www.binance.com/>`_ and
16-
`Bitstamp <https://www.bitstamp.net/>`_ crypto currency exchanges.
15+
* External integrations, where you'll find support for live trading at `Binance <https://www.binance.com/>`_,
16+
`Bitstamp <https://www.bitstamp.net/>`_ and 100+ crypto currency exchanges through
17+
`CCXT <https://github.com/ccxt/ccxt>`_.
1718

1819
Basana doesn't ship with technical indicators. The `examples at GitHub <https://github.com/gbeced/basana/tree/master/samples>`_
1920
take advantage of `TALIpp <https://github.com/nardew/talipp>`_ which is a good fit for event driven and real time applications,

‎docs/quickstart.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Basana requires Python 3.10 or above and to install the package you can use the
1212

1313
.. code-block:: console
1414
15-
$ pip install basana[charts]
15+
$ pip install basana[charts,ccxt]
1616
1717
The `examples at GitHub <https://github.com/gbeced/basana/tree/master/samples>`_ take advantage of TALIpp, Pandas and statsmodels.
1818
These can be installed using the following command:

0 commit comments

Comments
 (0)