## About
a [cli](https://en.wikipedia.org/wiki/Command-line_interface) application for displaying the current price of a cryptocurrency, designed (but not limited) to be ran in conky. cryptik supports multiple exchanges and multiple currencies.
Please see the project wiki for supported currencies and supported exchanges or to request new currencies/exchanges.
## Latest Changes
- changed version to use importlib.metadata
- update copyright date
- package updates: python-dateutil, types-python-dateutil
- change python version requirement from 3.8+ to 3.11+ (for speed and to leverage internal tomllib)
## NOTICES
- version 3.11.0 requires python 3.11+ (for internal toml processing capabilities and...its faster)
## Install
We recommend using [pipx](https://github.com/pypa/pipx) to install cryptik: `pipx install cryptik`. You can also install via pip: `pip install --user cryptik`.
cryptik uses a config file to store your setup. This file contains information such as the exchange(s) to use. You can grab the sample config file from [cryptik/example/config.toml](https://gitlab.com/drad/cryptik/-/blob/master/example/config.toml) and place it in `~/.config/cryptik` as this is where cryptik looks for the file by default or you can place it anywhere you like and use the `--config-file` parameter to specify the location.
## Usage
- call cryptik from command line: `cryptik -e BITSTAMP -t BTC`
+ show full response: `cryptik.py -d full`
- list all available exchanges: `cryptik.py -l`
- get help on cryptik: `cryptik.py -h`
- example conky usage (note: this will show prices from two exchanges):
```
CRYPTIK
${texeci 600 cryptik -e KRAKEN -t BTC}
${texeci 600 cryptik -e BITSTAMP -t BTC}
```
## Example Response
- direct call:
```
$ cryptik -e BITSTAMP -t BTC
BTMP:BTC $9711.24 @12:33
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/drad/cryptik",
"name": "cryptik",
"maintainer": "drad",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "sa@adercon.com",
"keywords": "cli, crypto, currency, bitcoin, ticker",
"author": "drad",
"author_email": "sa@adercon.com",
"download_url": "https://files.pythonhosted.org/packages/e2/8d/30d515184b6eb91ce03f5d932cc834799ce01b93091c25d3d65bb3605fef/cryptik-3.11.0.tar.gz",
"platform": null,
"description": "## About\n\na [cli](https://en.wikipedia.org/wiki/Command-line_interface) application for displaying the current price of a cryptocurrency, designed (but not limited) to be ran in conky. cryptik supports multiple exchanges and multiple currencies.\n\nPlease see the project wiki for supported currencies and supported exchanges or to request new currencies/exchanges.\n\n\n## Latest Changes\n\n- changed version to use importlib.metadata\n- update copyright date\n- package updates: python-dateutil, types-python-dateutil\n- change python version requirement from 3.8+ to 3.11+ (for speed and to leverage internal tomllib)\n\n\n## NOTICES\n\n- version 3.11.0 requires python 3.11+ (for internal toml processing capabilities and...its faster)\n\n\n## Install\n\nWe recommend using [pipx](https://github.com/pypa/pipx) to install cryptik: `pipx install cryptik`. You can also install via pip: `pip install --user cryptik`.\n\ncryptik uses a config file to store your setup. This file contains information such as the exchange(s) to use. You can grab the sample config file from [cryptik/example/config.toml](https://gitlab.com/drad/cryptik/-/blob/master/example/config.toml) and place it in `~/.config/cryptik` as this is where cryptik looks for the file by default or you can place it anywhere you like and use the `--config-file` parameter to specify the location.\n\n\n## Usage\n\n- call cryptik from command line: `cryptik -e BITSTAMP -t BTC`\n + show full response: `cryptik.py -d full`\n- list all available exchanges: `cryptik.py -l`\n- get help on cryptik: `cryptik.py -h`\n- example conky usage (note: this will show prices from two exchanges):\n\n```\nCRYPTIK\n ${texeci 600 cryptik -e KRAKEN -t BTC}\n ${texeci 600 cryptik -e BITSTAMP -t BTC}\n```\n\n## Example Response\n\n- direct call:\n```\n$ cryptik -e BITSTAMP -t BTC\nBTMP:BTC $9711.24 @12:33\n```\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "cryptocurrency prices on the command line",
"version": "3.11.0",
"project_urls": {
"Homepage": "https://gitlab.com/drad/cryptik",
"Repository": "https://gitlab.com/drad/cryptik"
},
"split_keywords": [
"cli",
" crypto",
" currency",
" bitcoin",
" ticker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03f22363488832f5f32892ad41b4abc2550be7a0d899fd50ceb45a8697156b8c",
"md5": "08147ba2c6a19da40a1cccc87dbb2577",
"sha256": "8ed00db3cc2358fe357ec5edf82aa47cadbeb7c4ad2dfee22fbf4614334b20ba"
},
"downloads": -1,
"filename": "cryptik-3.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08147ba2c6a19da40a1cccc87dbb2577",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 17691,
"upload_time": "2024-05-03T14:25:07",
"upload_time_iso_8601": "2024-05-03T14:25:07.176109Z",
"url": "https://files.pythonhosted.org/packages/03/f2/2363488832f5f32892ad41b4abc2550be7a0d899fd50ceb45a8697156b8c/cryptik-3.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e28d30d515184b6eb91ce03f5d932cc834799ce01b93091c25d3d65bb3605fef",
"md5": "6998cf1d4e05b5eb5e2e27bd9a12938f",
"sha256": "d8a7e4a765033560df6089ccae5fdf608ea8dfffe75cdf863fb10077b0feb8ce"
},
"downloads": -1,
"filename": "cryptik-3.11.0.tar.gz",
"has_sig": false,
"md5_digest": "6998cf1d4e05b5eb5e2e27bd9a12938f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 16784,
"upload_time": "2024-05-03T14:25:08",
"upload_time_iso_8601": "2024-05-03T14:25:08.897586Z",
"url": "https://files.pythonhosted.org/packages/e2/8d/30d515184b6eb91ce03f5d932cc834799ce01b93091c25d3d65bb3605fef/cryptik-3.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 14:25:08",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "drad",
"gitlab_project": "cryptik",
"lcname": "cryptik"
}
JSON