cryptopp
========
cryptopp is a lightweight command line based cryptocurrency portfolio.
Built on Python 3 and ncurses with simplicity in mind, cryptop updates in realtime.
.. image:: img\cryptop.png
version 1.0.1
Changes
------------
This now requires a CryptoCompare.com and CoinMarketCap.com API key because of rate limits and extra data points.
See the Credits section on how to get an API key.
Added option for extra decimal places in .cryptop/config.ini based on currency.locale
Fixed + add coin user error to just add coin instead of error.
Added Market Cap from CoinMarketCap. API required.
Reads wallet every refresh and entry. Enables cryptop to be run on multiple computers from within a sharedrive.
Less url requests. Coin list is fetched every 10 days, instead of
every coin addition. Speeds up processing of app.
TODO
------------
* Instead of using CC for 24h +/-, data already fetched from CMC in quote. Use CMC quote data for less requests.
* Add average price paid within wallet. Requires an addition "history" wallet.
* More historical portfolio changes.
* Coin Value +/- with mrkt conditions.
* History interface to interact with coin additions / subtractions.
Installation
------------
Via Pip
.. code:: bash
pip3 install cryptopp
Or locally
cryptop requires Python 3 to run, and has only been tested in Python 3.6-3.10 so far.
First clone this repo
.. code:: bash
git clone https://github.com/GordianSimpul/cryptopp
Then install cryptop through pip
.. code:: bash
cd cryptopp
pip3 install -e .
Make sure $HOME/.local/bin is in your environment PATH variable.
Usage
-----
Start from a terminal.
.. code:: bash
cryptopp [-k api_key] [-l api_key]
Follow the on screen instructions to add/remove or add/subtract values from your current wallet. The api_key options are only necessary if you didn't specify it in the .cryptop/config.ini file. An initial run is necessary to copy over config.ini to the .cryptop directory.
.cryptop/config.ini
.. code:: bash
key=CryptoComare API KEY
key2=CoinMarketCap API KEY
Both of those need to edited o/w cryptop will not work.
Customisation
-------------
Cryptop creates two config files in a .cryptop folder in your home directory.
.cryptop/config.ini contains theme configuration (text/background colors) and
options to change the output currency (default USD), update frequency, number of decimal places to display and maximum width for float values.
.cryptop/wallet.json contains the coins and amounts you hold, you shouldn't need to edit it manually
Credits / API
-------------
Both are FREE.
Uses the `cryptocompare.com API
<http://www.cryptocompare.com/>`_.
Uses the `coinmarketcap.com API
<https://coinmarketcap.com/api>`_.
Tipjar
-------------
Help me reach my goal of contributing to the ongoing development of privacy coins
.. code:: bash
XMR: 83az9t2fLjoC25d9UBUUiM1v6zemeKhjNf2Qw2Fnk1MFB3ecDx5oNVEG2tmdJJbxc97oAgjVbgCKHEgwTNFALh2c9jeWfdS
.. code:: bash
DERO: dero1qyxctkgzee00jh3md4etc8kxkr8x4hh7cckezrhn7de39kj4xaf9xqqa6xeta
.. code:: bash
BTC: bc1qfckkcnxxhxh5h0hnuc8gucymuvnxrw2a4traws
.. code:: bash
ARRR: zs1gn457262c52z5xa666k77zafqmke0hd60qvc38dk48w9fx378h4zjs5rrwnl0x8qazj4q3x4svz
Disclaimer
----------
I am not liable for the accuracy of this program’s output nor actions
performed based upon it.
Raw data
{
"_id": null,
"home_page": "https://github.com/GordianSimpul/cryptopp",
"name": "cryptopp",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "crypto cli portfolio curses cryptocurrency bitcoin",
"author": "GordianSimpul/huwwp",
"author_email": "gordian@simpul.me",
"download_url": "https://files.pythonhosted.org/packages/0a/fe/14eba2908aab100e9b482cd319c4ca9667fecde6440305cee7c766833db0/cryptopp-1.0.3.tar.gz",
"platform": null,
"description": "cryptopp\n========\ncryptopp is a lightweight command line based cryptocurrency portfolio.\nBuilt on Python 3 and ncurses with simplicity in mind, cryptop updates in realtime.\n\n.. image:: img\\cryptop.png\n\nversion 1.0.1\n\nChanges\n------------\n\nThis now requires a CryptoCompare.com and CoinMarketCap.com API key because of rate limits and extra data points.\n\nSee the Credits section on how to get an API key.\n\nAdded option for extra decimal places in .cryptop/config.ini based on currency.locale\n\nFixed + add coin user error to just add coin instead of error.\n\nAdded Market Cap from CoinMarketCap. API required.\n\nReads wallet every refresh and entry. Enables cryptop to be run on multiple computers from within a sharedrive.\n\nLess url requests. Coin list is fetched every 10 days, instead of \nevery coin addition. Speeds up processing of app.\n\n\nTODO\n------------\n\n* Instead of using CC for 24h +/-, data already fetched from CMC in quote. Use CMC quote data for less requests.\n* Add average price paid within wallet. Requires an addition \"history\" wallet.\n* More historical portfolio changes.\n* Coin Value +/- with mrkt conditions.\n* History interface to interact with coin additions / subtractions.\n\n\nInstallation\n------------\n\nVia Pip\n\n.. code:: bash\n\n pip3 install cryptopp\n\nOr locally\n\ncryptop requires Python 3 to run, and has only been tested in Python 3.6-3.10 so far.\n\nFirst clone this repo\n\n.. code:: bash\n\n git clone https://github.com/GordianSimpul/cryptopp\n\nThen install cryptop through pip\n\n.. code:: bash\n\n cd cryptopp\n pip3 install -e .\n\n\nMake sure $HOME/.local/bin is in your environment PATH variable. \n\nUsage\n-----\n\nStart from a terminal.\n\n.. code:: bash\n\n cryptopp [-k api_key] [-l api_key]\n\nFollow the on screen instructions to add/remove or add/subtract values from your current wallet. The api_key options are only necessary if you didn't specify it in the .cryptop/config.ini file. An initial run is necessary to copy over config.ini to the .cryptop directory. \n\n.cryptop/config.ini\n\n.. code:: bash\n\n key=CryptoComare API KEY\n key2=CoinMarketCap API KEY\n\nBoth of those need to edited o/w cryptop will not work.\n\nCustomisation\n-------------\n\nCryptop creates two config files in a .cryptop folder in your home directory.\n\n.cryptop/config.ini contains theme configuration (text/background colors) and\noptions to change the output currency (default USD), update frequency, number of decimal places to display and maximum width for float values.\n\n.cryptop/wallet.json contains the coins and amounts you hold, you shouldn't need to edit it manually\n\nCredits / API\n-------------\n\nBoth are FREE.\n\nUses the `cryptocompare.com API\n<http://www.cryptocompare.com/>`_.\n\nUses the `coinmarketcap.com API\n<https://coinmarketcap.com/api>`_.\n\nTipjar\n-------------\n\nHelp me reach my goal of contributing to the ongoing development of privacy coins\n\n.. code:: bash\n\n XMR: 83az9t2fLjoC25d9UBUUiM1v6zemeKhjNf2Qw2Fnk1MFB3ecDx5oNVEG2tmdJJbxc97oAgjVbgCKHEgwTNFALh2c9jeWfdS\n\n.. code:: bash\n\n DERO: dero1qyxctkgzee00jh3md4etc8kxkr8x4hh7cckezrhn7de39kj4xaf9xqqa6xeta\n\n.. code:: bash\n\n BTC: bc1qfckkcnxxhxh5h0hnuc8gucymuvnxrw2a4traws\n\n.. code:: bash\n \n ARRR: zs1gn457262c52z5xa666k77zafqmke0hd60qvc38dk48w9fx378h4zjs5rrwnl0x8qazj4q3x4svz\n\n\n\nDisclaimer\n----------\n\nI am not liable for the accuracy of this program\u2019s output nor actions\nperformed based upon it.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Command line Cryptocurrency Portfolio",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/GordianSimpul/cryptopp"
},
"split_keywords": [
"crypto",
"cli",
"portfolio",
"curses",
"cryptocurrency",
"bitcoin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4af49a21489c5df480f2bde9104acca69965f402831c0a0b255098643a9f3ac4",
"md5": "795096abc66dbd11b2f18463a9253b8c",
"sha256": "694605c9d9ff566dd325f3bb47e6f8e612fd784d98686bbe1234c9f3779ef49e"
},
"downloads": -1,
"filename": "cryptopp-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "795096abc66dbd11b2f18463a9253b8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21115,
"upload_time": "2023-06-01T05:00:10",
"upload_time_iso_8601": "2023-06-01T05:00:10.188558Z",
"url": "https://files.pythonhosted.org/packages/4a/f4/9a21489c5df480f2bde9104acca69965f402831c0a0b255098643a9f3ac4/cryptopp-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0afe14eba2908aab100e9b482cd319c4ca9667fecde6440305cee7c766833db0",
"md5": "f8651eb7b282628edf2ffff6d8e20705",
"sha256": "12a55a808da8892dd6df609c4490524339b9523d259dadb84a3f2c4bc30efdc8"
},
"downloads": -1,
"filename": "cryptopp-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "f8651eb7b282628edf2ffff6d8e20705",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22189,
"upload_time": "2023-06-01T05:00:12",
"upload_time_iso_8601": "2023-06-01T05:00:12.302831Z",
"url": "https://files.pythonhosted.org/packages/0a/fe/14eba2908aab100e9b482cd319c4ca9667fecde6440305cee7c766833db0/cryptopp-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-01 05:00:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GordianSimpul",
"github_project": "cryptopp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cryptopp"
}
JSON
