Skip to main content

A reusable django app that provides locally updated exchange rates to your app

Project description

.. image:: https://travis-ci.org/brightwrite/dj-currencies.svg?branch=master
:target: https://travis-ci.org/brightwrite/dj-currencies

Documentation
-------------

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

Quickstart
----------

Install djcurrencies::

pip install dj-currencies

Add it to your `INSTALLED_APPS`:

.. code-block:: python

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

Settings
========


.. code-block:: python

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




History
-------

0.0.1 (2018-04-23)
++++++++++++++++++

* First release on PyPI.

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

dj-currencies-0.1.1.tar.gz (9.8 kB view details)

Uploaded Source

File details

Details for the file dj-currencies-0.1.1.tar.gz.

File metadata

  • Download URL: dj-currencies-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

File hashes

Hashes for dj-currencies-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2e55b43cbbf639dd13c2d1ea5b0a0c276e7e0f17672c21981a071a061e8106a5
MD5 1773813c5daedb6fd79970866fdda8d2
BLAKE2b-256 d3f3b054134c502a4441ab58e7057782e395fe91de9515b86a3d675fd7aef06c

See more details on using hashes here.

Supported by

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