add entry for cli

sirfoga · Dec 27, 2017 · 68379fd · 68379fd
1 parent 8f9d0b4
commit 68379fd
Show file tree

Hide file tree

Showing 102 changed files with 1,276 additions and 662 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@
 - [Overview](#overview)
 - [Settings](#settings)
 - [Usage](#usage)
+- [Install](#install)
 - [Changelog](#changelog)
 - [Contribute](#contribute)
 - [License](#license)
@@ -70,6 +71,20 @@ would result in a series of plot like this one:
 
 Note that actual data has been omitted
 
+## Install
+Just run `./install.sh` and test your installation with `pyhodl -h`. Should come out
+```bash
+usage: -[mode] -h/--help for full usage
+
+optional arguments:
+  -h, --help           show this help message and exit
+  -updater, --update   Syncs local data with the transactions from your
+                       exchanges
+  -plotter, --plot     Creates charts of your data
+  -stats, --stats      Computes statistics and trends using local data
+  -verbose, --verbose  Increase verbosity
+```
+
 ## Changelog
 See [CHANGELOG](https://github.com/sirfoga/pyhodl/blob/master/CHANGELOG.md)
 

diff --git a/data/sample_bitfinex.csv b/data/sample_bitfinex.csv
diff --git a/data/sample_coinbase.csv b/data/sample_coinbase.csv
diff --git a/docs/api-objects.txt b/docs/api-objects.txt
@@ -2,8 +2,6 @@ pyhodl	pyhodl-module.html
 pyhodl.__package__	pyhodl-module.html#__package__
 pyhodl.apis	pyhodl.apis-module.html
 pyhodl.apis.__package__	pyhodl.apis-module.html#__package__
-pyhodl.apis.exchanges	pyhodl.apis.exchanges-module.html
-pyhodl.apis.exchanges.__package__	pyhodl.apis.exchanges-module.html#__package__
 pyhodl.apis.manage	pyhodl.apis.manage-module.html
 pyhodl.apis.manage.API_CONFIG	pyhodl.apis.manage-module.html#API_CONFIG
 pyhodl.app	pyhodl.app-module.html
@@ -19,8 +17,12 @@ pyhodl.charts	pyhodl.charts-module.html
 pyhodl.charts.__package__	pyhodl.charts-module.html#__package__
 pyhodl.charts.balances	pyhodl.charts.balances-module.html
 pyhodl.charts.balances.trend_function	pyhodl.charts.balances-module.html#trend_function
-pyhodl.controller	pyhodl.controller-module.html
-pyhodl.controller.__package__	pyhodl.controller-module.html#__package__
+pyhodl.cli	pyhodl.cli-module.html
+pyhodl.cli.parse_args	pyhodl.cli-module.html#parse_args
+pyhodl.cli.handle_exception	pyhodl.cli-module.html#handle_exception
+pyhodl.cli.main	pyhodl.cli-module.html#main
+pyhodl.cli.create_args	pyhodl.cli-module.html#create_args
+pyhodl.cli.cli	pyhodl.cli-module.html#cli
 pyhodl.data	pyhodl.data-module.html
 pyhodl.data.__package__	pyhodl.data-module.html#__package__
 pyhodl.data.core	pyhodl.data.core-module.html
@@ -36,6 +38,10 @@ pyhodl.exchanges.bitfinex	pyhodl.exchanges.bitfinex-module.html
 pyhodl.exchanges.coinbase	pyhodl.exchanges.coinbase-module.html
 pyhodl.exchanges.core	pyhodl.exchanges.core-module.html
 pyhodl.exchanges.gdax	pyhodl.exchanges.gdax-module.html
+pyhodl.models	pyhodl.models-module.html
+pyhodl.models.__package__	pyhodl.models-module.html#__package__
+pyhodl.models.exchanges	pyhodl.models.exchanges-module.html
+pyhodl.models.exchanges.__package__	pyhodl.models.exchanges-module.html#__package__
 pyhodl.plotter	pyhodl.plotter-module.html
 pyhodl.plotter.__package__	pyhodl.plotter-module.html#__package__
 pyhodl.requests	pyhodl.requests-module.html
@@ -56,17 +62,14 @@ pyhodl.updater.__package__	pyhodl.updater-module.html#__package__
 pyhodl.updater.core	pyhodl.updater.core-module.html
 pyhodl.updater.core.UPDATE_CONFIG	pyhodl.updater.core-module.html#UPDATE_CONFIG
 pyhodl.updater.exchanges	pyhodl.updater.exchanges-module.html
+pyhodl.updater.exchanges.INT_32_MAX	pyhodl.updater.exchanges-module.html#INT_32_MAX
 pyhodl.user	pyhodl.user-module.html
 pyhodl.user.__package__	pyhodl.user-module.html#__package__
 pyhodl.utils	pyhodl.utils-module.html
 pyhodl.utils.get_actual_class_name	pyhodl.utils-module.html#get_actual_class_name
 pyhodl.utils.get_full_lists	pyhodl.utils-module.html#get_full_lists
 pyhodl.utils.generate_dates	pyhodl.utils-module.html#generate_dates
 pyhodl.utils.__package__	pyhodl.utils-module.html#__package__
-pyhodl.apis.exchanges.ApiClient	pyhodl.apis.exchanges.ApiClient-class.html
-pyhodl.apis.exchanges.ApiClient.__init__	pyhodl.apis.exchanges.ApiClient-class.html#__init__
-pyhodl.apis.exchanges.BitfinexClient	pyhodl.apis.exchanges.BitfinexClient-class.html
-pyhodl.apis.exchanges.ApiClient.__init__	pyhodl.apis.exchanges.ApiClient-class.html#__init__
 pyhodl.apis.manage.ApiConfig	pyhodl.apis.manage.ApiConfig-class.html
 pyhodl.apis.manage.ApiConfig.build_api	pyhodl.apis.manage.ApiConfig-class.html#build_api
 pyhodl.apis.manage.ApiConfig.get_client	pyhodl.apis.manage.ApiConfig-class.html#get_client
@@ -120,6 +123,10 @@ pyhodl.charts.balances.Plotter.CURRENCY_EQUIV	pyhodl.charts.balances.Plotter-cla
 pyhodl.charts.balances.Plotter.plot_total_equiv	pyhodl.charts.balances.Plotter-class.html#plot_total_equiv
 pyhodl.charts.balances.Plotter.plot_fiat_crypto	pyhodl.charts.balances.Plotter-class.html#plot_fiat_crypto
 pyhodl.charts.balances.Plotter.__init__	pyhodl.charts.balances.Plotter-class.html#__init__
+pyhodl.cli.RunMode	pyhodl.cli.RunMode-class.html
+pyhodl.cli.RunMode.STATS	pyhodl.cli.RunMode-class.html#STATS
+pyhodl.cli.RunMode.PLOTTER	pyhodl.cli.RunMode-class.html#PLOTTER
+pyhodl.cli.RunMode.UPDATER	pyhodl.cli.RunMode-class.html#UPDATER
 pyhodl.data.core.BalanceParser	pyhodl.data.core.BalanceParser-class.html
 pyhodl.data.core.BalanceParser.parse_folder	pyhodl.data.core.BalanceParser-class.html#parse_folder
 pyhodl.data.core.BalanceParser.parse_raw_balances	pyhodl.data.core.BalanceParser-class.html#parse_raw_balances
@@ -309,21 +316,40 @@ pyhodl.updater.core.Updater.run	pyhodl.updater.core.Updater-class.html#run
 pyhodl.updater.core.Updater.__init__	pyhodl.updater.core.Updater-class.html#__init__
 pyhodl.updater.exchanges.BinanceUpdater	pyhodl.updater.exchanges.BinanceUpdater-class.html
 pyhodl.updater.exchanges.ExchangeUpdater.build_updater	pyhodl.updater.exchanges.ExchangeUpdater-class.html#build_updater
+pyhodl.updater.exchanges.BinanceUpdater.get_withdraw	pyhodl.updater.exchanges.BinanceUpdater-class.html#get_withdraw
+pyhodl.updater.exchanges.ExchangeUpdater.save_data	pyhodl.updater.exchanges.ExchangeUpdater-class.html#save_data
+pyhodl.updater.exchanges.BinanceUpdater.get_symbols_list	pyhodl.updater.exchanges.BinanceUpdater-class.html#get_symbols_list
+pyhodl.updater.exchanges.BinanceUpdater.get_deposits	pyhodl.updater.exchanges.BinanceUpdater-class.html#get_deposits
+pyhodl.updater.exchanges.ExchangeUpdater.update	pyhodl.updater.exchanges.ExchangeUpdater-class.html#update
 pyhodl.updater.exchanges.BinanceUpdater.get_transactions	pyhodl.updater.exchanges.BinanceUpdater-class.html#get_transactions
+pyhodl.updater.exchanges.BinanceUpdater.get_all_transactions	pyhodl.updater.exchanges.BinanceUpdater-class.html#get_all_transactions
 pyhodl.updater.exchanges.ExchangeUpdater.__init__	pyhodl.updater.exchanges.ExchangeUpdater-class.html#__init__
 pyhodl.updater.exchanges.BitfinexUpdater	pyhodl.updater.exchanges.BitfinexUpdater-class.html
+pyhodl.updater.exchanges.BitfinexUpdater.get_movements	pyhodl.updater.exchanges.BitfinexUpdater-class.html#get_movements
 pyhodl.updater.exchanges.ExchangeUpdater.build_updater	pyhodl.updater.exchanges.ExchangeUpdater-class.html#build_updater
+pyhodl.updater.exchanges.BitfinexUpdater.get_currencies_list	pyhodl.updater.exchanges.BitfinexUpdater-class.html#get_currencies_list
+pyhodl.updater.exchanges.ExchangeUpdater.update	pyhodl.updater.exchanges.ExchangeUpdater-class.html#update
+pyhodl.updater.exchanges.ExchangeUpdater.save_data	pyhodl.updater.exchanges.ExchangeUpdater-class.html#save_data
+pyhodl.updater.exchanges.BitfinexUpdater.get_all_movements	pyhodl.updater.exchanges.BitfinexUpdater-class.html#get_all_movements
+pyhodl.updater.exchanges.BitfinexUpdater.get_symbols_list	pyhodl.updater.exchanges.BitfinexUpdater-class.html#get_symbols_list
 pyhodl.updater.exchanges.BitfinexUpdater.get_transactions	pyhodl.updater.exchanges.BitfinexUpdater-class.html#get_transactions
+pyhodl.updater.exchanges.BitfinexUpdater.get_all_transactions	pyhodl.updater.exchanges.BitfinexUpdater-class.html#get_all_transactions
 pyhodl.updater.exchanges.ExchangeUpdater.__init__	pyhodl.updater.exchanges.ExchangeUpdater-class.html#__init__
 pyhodl.updater.exchanges.CoinbaseUpdater	pyhodl.updater.exchanges.CoinbaseUpdater-class.html
 pyhodl.updater.exchanges.ExchangeUpdater.build_updater	pyhodl.updater.exchanges.ExchangeUpdater-class.html#build_updater
 pyhodl.updater.exchanges.CoinbaseUpdater.get_transactions	pyhodl.updater.exchanges.CoinbaseUpdater-class.html#get_transactions
-pyhodl.updater.exchanges.ExchangeUpdater.__init__	pyhodl.updater.exchanges.ExchangeUpdater-class.html#__init__
+pyhodl.updater.exchanges.ExchangeUpdater.save_data	pyhodl.updater.exchanges.ExchangeUpdater-class.html#save_data
+pyhodl.updater.exchanges.CoinbaseUpdater.__init__	pyhodl.updater.exchanges.CoinbaseUpdater-class.html#__init__
+pyhodl.updater.exchanges.ExchangeUpdater.update	pyhodl.updater.exchanges.ExchangeUpdater-class.html#update
 pyhodl.updater.exchanges.ExchangeUpdater	pyhodl.updater.exchanges.ExchangeUpdater-class.html
 pyhodl.updater.exchanges.ExchangeUpdater.build_updater	pyhodl.updater.exchanges.ExchangeUpdater-class.html#build_updater
+pyhodl.updater.exchanges.ExchangeUpdater.save_data	pyhodl.updater.exchanges.ExchangeUpdater-class.html#save_data
 pyhodl.updater.exchanges.ExchangeUpdater.get_transactions	pyhodl.updater.exchanges.ExchangeUpdater-class.html#get_transactions
+pyhodl.updater.exchanges.ExchangeUpdater.update	pyhodl.updater.exchanges.ExchangeUpdater-class.html#update
 pyhodl.updater.exchanges.ExchangeUpdater.__init__	pyhodl.updater.exchanges.ExchangeUpdater-class.html#__init__
 pyhodl.updater.exchanges.GdaxUpdater	pyhodl.updater.exchanges.GdaxUpdater-class.html
 pyhodl.updater.exchanges.ExchangeUpdater.build_updater	pyhodl.updater.exchanges.ExchangeUpdater-class.html#build_updater
 pyhodl.updater.exchanges.GdaxUpdater.get_transactions	pyhodl.updater.exchanges.GdaxUpdater-class.html#get_transactions
-pyhodl.updater.exchanges.ExchangeUpdater.__init__	pyhodl.updater.exchanges.ExchangeUpdater-class.html#__init__
+pyhodl.updater.exchanges.ExchangeUpdater.save_data	pyhodl.updater.exchanges.ExchangeUpdater-class.html#save_data
+pyhodl.updater.exchanges.GdaxUpdater.__init__	pyhodl.updater.exchanges.GdaxUpdater-class.html#__init__
+pyhodl.updater.exchanges.ExchangeUpdater.update	pyhodl.updater.exchanges.ExchangeUpdater-class.html#update
diff --git a/docs/class-tree.html b/docs/class-tree.html
@@ -57,14 +57,6 @@
 </b></center><br />
 <h1 class="epydoc">Class Hierarchy</h1>
 <ul class="nomargin-top">
-    <li> <strong class="uidlink"><a href="pyhodl.apis.exchanges.ApiClient-class.html">pyhodl.apis.exchanges.ApiClient</a></strong>:
-      <em class="summary">Client to use API</em>
-    <ul>
-    <li> <strong class="uidlink"><a href="pyhodl.apis.exchanges.BitfinexClient-class.html">pyhodl.apis.exchanges.BitfinexClient</a></strong>:
-      <em class="summary">Binance client</em>
-    </li>
-    </ul>
-    </li>
     <li> <strong class="uidlink"><a href="pyhodl.apis.manage.ApiConfig-class.html">pyhodl.apis.manage.ApiConfig</a></strong>:
       <em class="summary">Config of API</em>
     </li>
@@ -129,7 +121,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Wed Dec 27 16:52:36 2017
+    Generated by Epydoc 3.0.1 on Wed Dec 27 23:23:40 2017
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"

diff --git a/docs/help.html b/docs/help.html
@@ -250,7 +250,7 @@ <h2> The Navigation Bar </h2>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Wed Dec 27 16:52:36 2017
+    Generated by Epydoc 3.0.1 on Wed Dec 27 23:23:40 2017
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"