Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 1.65 KB

README.rst

File metadata and controls

70 lines (45 loc) · 1.65 KB
Raw

Documentation

The full documentation is at https://dj-currencies.readthedocs.io.

Quickstart

For Django 2 support, please use version 0.1.2. Django 3 support added in version 1.0. Django 4 support from version >=1.1.

Install djcurrencies:

pip install dj-currencies

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'dj_currencies',
    ...
)

Settings

DJANGO_CURRENCIES = {
    'DEFAULT_BACKEND': 'djmoney_rates.backends.OpenExchangeBackend',
    'OPENEXCHANGE_APP_ID': '',
    'BASE_CURRENCIES': ['USD'],
    'MAX_CACHE_DAYS': 7
}

DEFAULT_BACKEND: The selected backend to sync exchange rates

OPENEXCHANGE_APP_ID: Must be configured if you use OpenExchangeBackend

BASE_CURRENCIES: A list of base currencies to use. At the time of this version, you will only be able to convert currency from any one of the base currency to target currency.

MAX_CACHE_DAYS: Only use the cache within this time limit. If exchange rates was not synced within the time frame, an exception will thrown

Note

You will need to have at least "OPENEXCHANGE_APP_ID" configured if you use OpenExchangeBackend

Features

  • [open exchange rates](openexchangerates.org) integration
  • Extensible backend design, hook your own exchange rate sources
  • Multi base currencies support, no double conversion to lose precision
  • Store historical exchange rates
  • offline currency conversion

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ python runtests.py