Skip to main content

A package for maintaining and interacting with a local forex database.

Project description

local-forex

A free python package to help get started in building and interacting with a local database of currency exchange rates.

Dictionary based currency exchange rate package

  • Rates provided by Bank of Canada. Includes function for fetching and saving latest rates using BoC API
  • Offline JSON historical database reduces reliance on external API availability (records to 2017-01-03, TODO: extend historical records)
  • ~24 modern currencies supported

Installation

pip install local-forex
cd local-forex
pip install -r requirements.txt

Example conversion

import local_forex

fx = local_forex.ForexRates()

# Example conversion rate query for USD/EUR on December 02, 2020
from datetime import datetime
rate = local_forex.get_conversion_rate(base="USD", quote="EUR", date=datetime(2020,12,02))

Backfilling rates

  • backfill.py is included for convenience. Run Mon-Fri after 16:30EST to update database daily (e.g. Launchd on MacOS).
online_rates = fx.fetch_boc_rates()
fx.update_from_boc_rates(online_rates)
fx.save_rates_to_file()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

local_forex-0.1.9.tar.gz (177.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

local_forex-0.1.9-py3-none-any.whl (193.1 kB view details)

Uploaded Python 3

File details

Details for the file local_forex-0.1.9.tar.gz.

File metadata

  • Download URL: local_forex-0.1.9.tar.gz
  • Upload date:
  • Size: 177.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for local_forex-0.1.9.tar.gz
Algorithm Hash digest
SHA256 337c7fd209eadfbca9e5749142a9a569033e11294605d4ebdc10ac1f0c6d7163
MD5 cd9a4ce025acf050afc13d3aeac5ceae
BLAKE2b-256 53f697d9574a11a838f0d498e61d967f42aeef3395150c9a22c9899ae3ac2784

See more details on using hashes here.

File details

Details for the file local_forex-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: local_forex-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 193.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for local_forex-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0c29f3a1881049b4fdb2c891d045da93721a47799e1b3235fb48029d0115d39a
MD5 24fba5c48e2b4cbe2326f95cc6d08cce
BLAKE2b-256 4bec12a15977e3da4668a1ef6b9aa40cd86e66a76643ee34640453c5284bbcf1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page