pyhodl
pyhodl copied to clipboard
:snake: Static analysis of your crypto-transactions. Completely off-line and security-oriented
pyhodl | Download, update, analyze and plot your crypto-transactions. Completely off-line and secure (you own your data).
Made with love and crypto money.Table of Contents
- Key Features
- Usage
- Example
- Install
- Changelog
- Contribute
- License
- Links
- You may also like...
Key Features
- continuous (hourly, daily, you-decide-when) updates from your exchanges
- completely off-line
- you own your data
- analyze profit and ROI of transactions
- plot charts (buy/sells, prices, market cap ...)
- stats and trends
- cross-OS
- supported exchanges:
- Binance
- Bitfinex
- Coinbase
- GDAX
Usage
$ pyhodl [options]
To specify your settings, please refer to this. To import your transactions, please refer to the guide.
Supported commands
The following flags are supported:
Flag | Description | Allowed attributes |
---|---|---|
-h |
show this help message and exit | None |
-m |
Choose run mode | {plotter,stats,download,update} |
-p |
Path to use as input | any OS existent path |
-t |
Connect to tor via this password (advanced) | any string |
-v |
Increase verbosity | nothing, just add -v |
Example
A simple run with parameters like
pyhodl -plot "~/.pyhodl/data/BitfinexUpdater.json" -verbose
would result in a plot like this one:
while if you want to plot your gains against your total spent, just run
-plot -verbose
Documentation
If you want to browse the full documentation please go here, or clone the repo and navigate to the index file.
API example
To show how simple it is, take a look at the code on how to produce the chart of the example:
wallets = exchange.build_wallets().values() # get wallets
plotter = FiatPlotter(wallets) # setup plot
plotter.plot_buy_sells("XRP") # plot buy/sells data
Install
Just run ./install.sh
and test your installation with pyhodl -h
. Should come out
usage: -[mode] -h/--help for full usage
optional arguments:
-h, --help show this help message and exit
-m {plotter,stats,download,update}, --mode {plotter,stats,download,update}
Run mode
-p PATH, --path PATH Path to use as input
-t TOR, --tor TOR Connect to tor via this password (advanced)
-v, --verbose Increase verbosity
To run the tests (please do):
python3 setup.py test
Changelog
See CHANGELOG
Contribute
- Open an issue
- fork this repository
- create your feature branch (
git checkout -b my-new-feature
) - commit your changes (
git commit -am 'Added my new feature'
) - publish the branch (
git push origin my-new-feature
) - open a PR
License
Links
You may also like...
- cryptowatch - Uses cryptowat.ch and tradingview.com APIs to display charts side-by-side