Package: quicktick
Output a cryptocurrency price ticker to stdout based on the
configuration found, by default, in~/.quicktick. Options can be
provided at the command line to override any part of the ticker
configuration.Installationquicktick requires Python 3.6, or newer, and can be installed usingpip:pip install quicktickUsagequicktick [-h] [-V] [--config CONFIG] [--crypto CRYPTO] [--fiat FIAT] [--template TEMPLATE] [--source SOURCE]Options are as follows:-h,--helpShow this help message and exit-V,--versionShow version and license information--configCONFIGUse alternative configuration file--cryptoCRYPTOSymbol to use as the cryptocurrency--fiatFIATSymbol to use as the fiat currency--templateTEMPLATETemplate name or raw Jinja2 template--sourceSOURCESource for the price dataConfigurationThe configuration is a YAML file, which will be created in your home
directory on first run (if it doesn’t already exist), which defines the
default ticker, how to output price data and how data sources are
defined. Jinja2 templating is used to make this very adaptable to your
needs.The default configuration only defines a data source for theCoinMarketCapAPI with support for:Cryptocurrencies:BitcoinBitcoin CashEthereumLitecoinFiat currencies:US DollarsEurosChinese YuanBritish PoundsPrice data:Exchange rateChange in the last hourCoinMarketCap’s API supports many more options and these can be added to
your configuration, as needed. Alternatively, other JSON-based HTTP APIs
can be defined as data sources.TickerThe default ticker is defined under thetickersection in the
configuration. It takes four attributes:sourceThe data source to use, defined in thesourcessection.cryptoThe cryptocurrency symbol to use, as defined by thesource.fiatThe fiat currency symbol to use, as defined by thesource.templateThe template to use to render the ticker, defined in thetemplatessection (n.b., this must be a predefined template; a raw Jinja2
template string can only be used at the command line).TemplatesThetemplatessection is used to define named Jinja2 templates. By
default, there issimpleandansi(which is the same assimple, with ANSI escape sequences used for colour output). When the
templates are rendered, they have access to three sets of data:fiatThe fiat currency symbol (seeData Sourcesfor details).cryptoThe cryptocurrency symbol (seeData Sourcesfor details).Price dataThe price data variables returned by the data source (seeData
Sourcesfor details).Data SourcesThesourcessection is used to define named data sources; that is,
JSON-based HTTP APIs. Each data source takes four attributes:urlThe URL for the data source; again, a Jinja2 template that is supplied
with thefiatandcryptosymbols.dataThis subsection allows you to define the price data variables that are
available to the output template. These are again Jinja2 templates
that describe the mapping from the API’sjsonresponse, along with
thecryptoandfiatsymbols.cryptosandfiatsThese subsections allow you to define cryptocurrencies and fiat
currencies, respectively. Conventionally, you would use the symbol
name as the currency’s identifier, which take a dictionary of named
parameters. These parameters are then available to the templates that
use the symbols.LicenseCopyright (c) 2017 Christopher HarrisonThis program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.You should have received a copy of the GNU General Public License along
with this program. If not, see <https://www.gnu.org/licenses/>.