Summary

Clone URL:

git Use ID

Description:

Python library and CLI tool to query the Open Exchange Rates API

Trending files:

Statistics are disabled for this repository

Download:

Downloads are disabled for this repository

Latest Changes

Brett Smith	7c11ae408cc8	4 years ago	tests: Prep historical tests for parametrizing on output format.
Brett Smith	2d753c31aacd	4 years ago	historical: Add support for from_date arg.
Brett Smith	71893ace4dc0	4 years ago	tests: Historical tests use more flexible rate matching. tests: Historical tests use more flexible rate matching. This lets the tests be more flexible about how much precision is used in rates when appropriate, and makes them ready to parametrize for Beancount.
Brett Smith	fb2114896d9d	4 years ago	historical: Normalize class instantiation for formatters. historical: Normalize class instantiation for formatters. This will make them easier to extend with different price/cost rates, and to add a Beancount formatter.
Brett Smith	80fd49a98ad8	4 years ago	historical: Introduce --output-format option. historical: Introduce --output-format option. Beancount output will be added here.
Brett Smith	27dbe14b94eb	4 years ago	config: Accept a source date for displaying rates. config: Accept a source date for displaying rates. For output formats that can show both a cost and a price, this will be used to distinguish them.
Brett Smith	9b6d562d46f5	4 years ago	tests: Stop calling fixtures directly. tests: Stop calling fixtures directly. Avoid deprecation warnings from pytest.
Brett Smith	a3cc41a5cfea	7 years ago	tests: Run with oxrlib's decimal context.
Brett Smith	3b732505fa62	7 years ago	main: Decimal context sets the state of all traps. main: Decimal context sets the state of all traps. This commit started because I noticed in the decimal documentation that BasicContext doesn't trap decimal.Subnormal, while oxrlib probably should. The point of this function is to set all the parts of a context that oxrlib should have to handle currency correctly and safely. With that motivation, it makes more sense to set all the traps exactly as we want them, rather than selectively setting "important" ones: they're all important.
Brett Smith	cb17033279fb	7 years ago	config: Only try to load the default config file if it exists.

README.rst

oxrlib

Introduction

oxrlib provides a Python library and CLI tool to query the Open Exchange Rates API. It emphasizes support for rich data types throughout, and supports caching API results to the filesystem.

It currently only supports OXR's "historical" API.

Getting started with the CLI tool

oxrlib includes an <tt class="docutils literal">oxrquery</tt> tool to access the OXR API directly from the command line. By default, it reads your OXR credentials and other common configuration from <tt class="docutils literal">~/.config/oxrlib.ini</tt>. Copy <tt class="docutils literal">oxrlib_example.ini</tt> from the source to <tt class="docutils literal">~/.config/oxrlib.ini</tt>, then edit that file following the instructions in the comments.

Run <tt class="docutils literal">oxrquery --help</tt> for instructions to use the tool.

Getting started with the library

Here's an example of using the Python library, complete with caching results:

from oxrlib import cache, loaders, rate

filename_format = '{date}_{base}_rates.json'
cache_writer = cache.CacheWriter(DIR_PATH, historical=filename_format)
loader = loaders.LoaderChain()
loader.add_loader(loaders.FileCache(DIR_PATH, historical=filename_format))
loader.add_loader(loaders.OXRAPIRequest(APP_ID_STRING))
with loader.historical(DATE, BASE_CODE_STRING) as json_response:
    hist_rate = rate.Rate.from_json_file(json_response)
if loader.should_cache():
    cache_writer.save_rate(hist_rate)
# Rates are available from the hist_rate.rates dict.

Running tests

Run <tt class="docutils literal">./setup.py test</tt> from your checkout directory.