oxrlib/oxrlib_example.ini
Brett Smith 936237eceb config: Nicer determination of default currency for converting/signing.
base defaults to USD more as an API restriction than anything else, so avoid
using it as a default setting.  Instead, use the user's books denomination
or locale setting.
2017-06-09 13:22:12 -04:00

43 lines
1.4 KiB
INI

[OXR]
# This section includes settings to query the Open Exchange Rates API directly.
# An App ID provided by OXR.
app_id = abcd1234...
[Cache]
# This optional section includes settings to read and write a cache of API
# results on the filesystem. If you omit these settings, results won't be
# cached.
# The directory to save cache files under. This directory must already exist.
directory = /home/YOU/.cache/oxrlib
# Save data from the historical API using this filename pattern.
# The pattern must include `{date}` and `{base}`, where API parameters are
# filled in.
historical = {date}_{base}_rates.json
[Historical]
# This optional section can specify default parameters for historical API calls.
# Set the base currency.
# Note that setting a base other than USD requires a paid OXR account.
base = USD
# Write output in Ledger format.
ledger = no
# Denominate Ledger books in this currency.
# Ledger-formatted conversions will always show a rate to convert to this
# currency, even when converting between two other currencies.
# If not specified, output will show the rate for the currency you're
# converting to.
denomination = USD
# Use signs for these currencies in Ledger output.
# If not specified, defaults to the user's preferred currency, which is
# the first setting found from:
# 1. the denomination setting above
# 2. the user's locale
# 3. the base currency (which defaults to USD)
signed_currencies = USD, EUR