-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
48 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,71 @@ | ||
| krakenex-CurrencyViewer | ||
| ======================= | ||
| This is a short python3 program that dynamically displays and converts the cryptocurrencies in your Kraken wallet into equivalents fiat money. | ||
| krakenex-CurrencyViewer | ||
| ======================= | ||
| This is a short python3 program that dynamically displays and converts the cryptocurrencies in your Kraken wallet into equivalents fiat money. | ||
|
|
||
|
|
||
| If this script helped you or if you have any feedback, please don't hesitate to contact me. | ||
| If this script helped you or if you have any feedback, please don't hesitate to contact me. | ||
|
|
||
| Author : smechaab | ||
| Author : smechaab | ||
|
|
||
| Credits | ||
| ------- | ||
| This code is based on Krakenex Python3 API by veox: https://github.com/veox/python3-krakenex | ||
| Credits | ||
| ------- | ||
| This code is based on Krakenex Python3 API by veox: https://github.com/veox/python3-krakenex | ||
|
|
||
| * v0.1.3 | ||
| * v0.2.0 | ||
|
|
||
| This is a tiny program I personally use it daily. | ||
| It allows me to check my currencies without logging every 10 minutes on Kraken website. | ||
| This is also very useful for developers on the Krakenex API thanks to dynamically extracted data. | ||
| This is a tiny program I personally use it daily. | ||
| It allows me to check my currencies without logging every 10 minutes on Kraken website. | ||
| This is also very useful for developers on the Krakenex API thanks to dynamically extracted data. | ||
|
|
||
| Please note that you need to fill your kraken.key file with your API keys. You can easily generate a pair of keys on the Kraken website, see the API documentation : https://www.kraken.com/help/api | ||
| Please note that you need to fill your kraken.key file with your API keys. You can easily generate a pair of keys on the Kraken website, see the API documentation : https://www.kraken.com/help/api | ||
|
|
||
| v0.1.3 Changes | ||
| ---------------- | ||
| Adding CSV log writing feature. | ||
| Next updates will provide more object-oriented code and may be more library-oriented. | ||
| It is also planned to add other exchanges than Kraken. | ||
| v0.2.0 Changes | ||
| ---------------- | ||
| Adding CSV log writing feature. | ||
| Providing more object-oriented code and more library-oriented. | ||
|
|
||
| Your data logs are now stored by default in « data.csv » and is located in the same directory. | ||
| TODO : | ||
| It is also planned to add other exchanges than Kraken. | ||
|
|
||
| Have a nice summer;) | ||
| Your data logs are now stored by default in data.csv and is located in the same directory. | ||
|
|
||
| Program features | ||
| ---------------- | ||
| I wish you a good ‘back-to-school’ ! | ||
|
|
||
| 1. Displaying the different amount of crypto currencies you own on your Kraken wallet. | ||
| Program features | ||
| ---------------- | ||
|
|
||
| 2. Displaying the total crypto money you own in equivalent fiat money. | ||
| 1. Displaying the different amount of crypto currencies you own on your Kraken wallet. | ||
|
|
||
| 3. Adapted to the crypto and fiat currencies you already own. | ||
| 2. Displaying the total crypto money you own in equivalent fiat money. | ||
|
|
||
| 4. If you don't own any fiat money on your Kraken wallet, it will be displayed the equivalent in USD. | ||
| (The fiat money can be easily modified but be aware that some markets doesn't allow it, | ||
| DASHUSD -> DASHJPY for example, can't be done because the market doesn't exist on Kraken. | ||
| Check k.query_public('Ticker',{'pair': 'YOURMARKET',}) inline to know if it exist.) | ||
|
|
||
| 3. Adapted to the crypto and fiat currencies you already own. | ||
|
|
||
| 4. If you don't own any fiat money on your Kraken wallet, it will be displayed the equivalent in USD. | ||
|
|
||
| 5. Working with multi-fiat currencies wallets. | ||
|
|
||
| NOTE: Fiat currencies like JPY doesn't have as many markets as USD on Krakenex. | ||
| Crypto currencies that doesn't cover these markets, with JPY for example, aren't converted yet | ||
| Only markets with JPY are counted in the total sum value of JPY total | ||
| This issue will be fixed with the next commit | ||
| 6. Writes data in a csv file located in the project folder (default : data.csv). | ||
|
|
||
| NOTE: Some bugs need to be fixed with fiat currencies other than EUR or USD, | ||
| it will be patched in the next one. | ||
|
|
||
|
|
||
|
|
||
| Interesting variables | ||
| --------------------- | ||
| Interesting variables | ||
| --------------------- | ||
|
|
||
| * ``data`` : Raw data received from Kraken API of user's current wallet | ||
| * ``data_price`` : Raw real-time data received from Kraken API of market pair (crypto/fiat) | ||
| * ``currencies`` : List of differents currencies owned by user | ||
| * ``balance`` : List of the differents amount of crypto currencies owned by client | ||
| * ``market`` : List of markets concerned by currencies in user's wallet (same order as price) | ||
| * ``price`` : List of prices of crypto currencies in markets concerned by user (same order as market) | ||
| * ``totals`` : List of total differents fiat money owned by user | ||
| * ``values`` : Dictionnary of current values in fiat money user's crypto currencies balance is equivalent to (according to real-time markets) | ||
| Keys are dynamically generated by markets concerned by user | ||
| * ``total`` : Dictionnary of total differents fiat money owned by user | ||
| * ``currencies`` : List of differents currencies owned by user | ||
| * ``balance`` : List of the differents amount of crypto currencies owned by client | ||
| * ``market`` : List of markets concerned by currencies in user's wallet (same order as price) | ||
| * ``values`` : Dictionnary of current values in fiat money user's crypto currencies balance is equivalent to (according to real-time markets) | ||
| Keys are dynamically generated by markets concerned by user | ||
| * ``total`` : Dictionnary of total differents fiat money owned by user | ||
|
|
||
|
|
||
|
|
||
|
|
||
| TODO: | ||
| ----- | ||
| 1. Manage exceptions with crypto/fiat currencies pair markets that doesn't exist on Kraken | ||
| 2. Add e-mail sender with timer or interruptions to user (user will add its own e-mail to ensure privacy) | ||
| 3. Add other exchanges | ||
| 4. Add a GUI | ||
| TODO: | ||
| ----- | ||
| 1. Add e-mail sender with timer or interruptions to user (user will add its own e-mail to ensure privacy) | ||
| 2. Add other exchanges | ||
| 3. Add a GUI |