From 38b14eb22401a2833945bf70b729ae7e0858f538 Mon Sep 17 00:00:00 2001
From: Jon Michael Aanes <jonjmaa@gmail.com>
Date: Sat, 20 Jul 2024 22:03:50 +0200
Subject: [PATCH] More documentation

---
 fin_depo/__init__.py | 35 ++++++++++++++++++++++++-----------
 test/test_kucoin.py  |  8 ++++++--
 2 files changed, 30 insertions(+), 13 deletions(-)

diff --git a/fin_depo/__init__.py b/fin_depo/__init__.py
index a4252f8..856dc59 100644
--- a/fin_depo/__init__.py
+++ b/fin_depo/__init__.py
@@ -2,19 +2,32 @@
 
 Python library for automatic fetching of personal asset depo information.
 
-Supports:
+## Supported services
 
-- **Kraken**: Uses their [publicly documented API](https://docs.kraken.com/rest/).
-- **Kucoin**: Uses their [publicly documented API](https://www.kucoin.com/docs/beginners/introduction).
-- **Partisia Blockchain Account**: Uses a reader node to check the account
-  state.
-- **Nordnet**: Through their
-  [API](https://www.nordnet.dk/externalapi/docs/api). Thanks to [Morten
-  Helmstedt](https://helmstedt.dk/) for sharing his [Nordnet
-  utilities](https://github.com/helmstedt/nordnet-utilities),
-  which helped a lot.
+[**Kraken**](https://www.kraken.com/) crypto-currency exchange
+(`KrakenDepoFetcher`): Uses their [publicly documented
+API](https://docs.kraken.com/rest/). This provides the same data as the
+homepage.
 
-## TODO
+[**Kucoin**](https://www.kucoin.com/) crypto-currency exchange
+(`KucoinDepoFetcher`): Uses their [publicly documented
+API](https://www.kucoin.com/docs/beginners/introduction). This provides the
+same data as is available on the Assets Overview Page.  This fetcher also
+allows for placing market orders, but be careful with this functionality.
+
+[**Partisia Blockchain**](https://browser.partisiablockchain.com/) wallet
+balances (`PartisiaBlockchainAccountDepoFetcher`): Uses a public reader node to
+check the account state. This is the same data as can be found in the Partisia
+Browser Assets page.
+
+[**Nordnet**](https://www.nordnet.dk) nordic investment bank
+(`NordnetDepoFetcher`): Uses their
+[API](https://www.nordnet.dk/externalapi/docs/api). Thanks to [Morten
+Helmstedt](https://helmstedt.dk/) for sharing his [Nordnet
+utilities](https://github.com/helmstedt/nordnet-utilities), which helped with
+implementing this functionality. Exposes the same data as the home page.
+
+## Future extension
 
 - [ ] Investment Bank: Saxo Bank OpenAPI
 - [ ] Personal Bank: Personal Bank Account (Open Banking) Maybe use AIIA?
diff --git a/test/test_kucoin.py b/test/test_kucoin.py
index 6eac792..cf178e1 100644
--- a/test/test_kucoin.py
+++ b/test/test_kucoin.py
@@ -59,7 +59,9 @@ def test_place_buy_side_order():
     input_amount = Decimal('0.1')
 
     order_details = fetcher.place_market_order(
-        fin_defs.USDT, input_amount, fin_defs.MPC,
+        fin_defs.USDT,
+        input_amount,
+        fin_defs.MPC,
     )
 
     assert order_details is not None
@@ -91,7 +93,9 @@ def test_place_sell_side_order():
     input_amount = Decimal('1')
 
     order_details = fetcher.place_market_order(
-        fin_defs.MPC, input_amount, fin_defs.USDT,
+        fin_defs.MPC,
+        input_amount,
+        fin_defs.USDT,
     )
 
     assert order_details is not None