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	5a73d3d8f8d4	14 months ago	historical: Move normalize_rate and _pretty_rate to base Formatter. historical: Move normalize_rate and _pretty_rate to base Formatter. This reduces the number of method overrides to help readability, and gets rid of the annoying format_rate/pretty_rate distinction. master
Brett Smith	77393ee80fde	14 months ago	tests: Make consistent rate test a little more robust.
Brett Smith	c9382a26044a	14 months ago	historical: Fix the rate ordering with two dates. historical: Fix the rate ordering with two dates. Darnit, I wrote the tests first, and I wrote them right, and then I mixed up the ordering in the code, and somehow I convinced myself the code was the right and the tests were wrong. But no, I had the tests right, this is really what we want. This gets the output to follow the examples from our bookkeeping documentation.
Brett Smith	ae3e4617d31e	14 months ago	historical: Always format rates with the same precision. historical: Always format rates with the same precision. When we format a rate as a price, we don't know how much precision is "enough" to do the conversion, because we don't know what's being converted to. As a result, we may (=will almost certainly) end up formatting the rate with different precision on the cost date vs. the price date, and that causes Beancount/Ledger to fail to make the connection between them. Using a constant of 6 is enough to make the current test for "enough" precision pass, so just do that for now. This might need further refinement in the future.
Brett Smith	8dede9d1398c	14 months ago	historical: Swap Ledger and Beancount formatters in the class hierarchy. historical: Swap Ledger and Beancount formatters in the class hierarchy. This makes sense for a couple of reasons: * The Beancount formatter has "less features" than the Ledger formatter, so this is a more "logical" organization of the hierarchy anyway. Note how this eliminates the need for the BeancountFormatter.__init__ override to turn off Ledger features. * Any future work will probably be focused on the Beancount formatter, so this reduces the amount of code you have to understand and hold in your head to do that.
Brett Smith	c3fd55ec15b7	14 months ago	historical: Beancount can handle commas in amounts. historical: Beancount can handle commas in amounts. And having it looks nicer, is more consistent with our historical books, is less code for me, and is no more trouble for the user.
Brett Smith	e158eae7d9ae	14 months ago	gitignore: Modernize.
Brett Smith	30e9f1c1e88a	14 months ago	setup: Version 2.0 for all the recent changes.
Brett Smith	5573caf7ee0e	14 months ago	oxrlib_example: Update for Beancount.
Brett Smith	3a3afb79786b	14 months ago	historical: Add Beancount output format.

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.