*.egg-info/

__pycache__/

Getting started with the CLI tool

---------------------------------

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

Run `oxrquery --help` 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_rates.rates dict.

#!/usr/bin/env python3

from setuptools import setup

setup(

    name='oxrlib',

    description="Library to query the Open Exchange Rates (OXR) API",

    version='1.0',

    author='Brett Smith',

    author_email='brettcsmith@brettcsmith.org',

    license='GNU AGPLv3+',

    packages=['oxrlib'],

    entry_points={

        'console_scripts': ['oxrquery = oxrlib.__main__:main'],

    },

)