Welcome to django-money-rates’s documentation!¶

Documentation¶

The full documentation is at http://django-money-rates.rtfd.org.

Quickstart¶

Install django-money-rates:

pip install django-money-rates

Then use it in a project:

import djmoney_rates

In order to save exchange rates to your database, add djmoney_rates to your INSTALLED_APPS in your project’s settings:

INSTALLED_APPS = (
    ...
    'djmoney_rates',
    ...
)

Setup the Open Exchange Rates backend¶

Open an account at https://openexchangerates.org/ if you don’t have one already. Then, add this to your project’s settings:

DJANGO_MONEY_RATES = {
    'DEFAULT_BACKEND': 'djmoney_rates.backends.OpenExchangeBackend',
    'OPENEXCHANGE_URL': 'http://openexchangerates.org/api/latest.json',
    'OPENEXCHANGE_APP_ID': 'YOUR APP ID HERE',
    'OPENEXCHANGE_BASE_CURRENCY': 'USD',
}

For more information on the Open Exchange Rates API, see https://openexchangerates.org/

Pull the latest Exchange Rates¶

Once your backend is setup, get the latest exchange rates:

$ ./manage.py update_rates

Convert from one currency to another¶

Here’s an example of converting 10 Euros to Brazilian Reais:

from moneyed import Money
from djmoney_rates.utils import convert_money
brl_money = convert_money(10, "EUR", "BRL")

Features¶

• Convert money from one currency to another with an easy to use API.

TODO List¶

• Add money converter wrapper for util’s convert_money function.
• Add celery periodic task for getting daily exchange rates.

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up django-money-rates for local development.

1. Fork the django-money-rates repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/django-money-rates.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv django-money-rates
   $ cd django-money-rates/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ flake8 djmoney_rates tests
    $ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/evonove/django-money-rates/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_djmoney_rates

Development Lead¶

• Federico Frenguelli <synasius@gmail.com>

Contributors¶

• Tim Zenderman <tzenderman@gmail.com>

0.3.0 (2013-12-30)¶

• convert_money utility function now returns moneyed.Money instances

0.1.0 (2013-10-16)¶

• First release on PyPI.