Welcome to djcurrencies’s documentation!¶

Contents:

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

Installation¶

At the command line:

$ pip install dj-currencies

Usage¶

To use djcurrencies in a project, add it to your INSTALLED_APPS:

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

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/CoverGenius/dj-currencies/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

djcurrencies could always use more documentation, whether as part of the official djcurrencies docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/lihan/dj-currencies/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up dj-currencies for local development.

Fork the dj-currencies repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/dj-currencies.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv dj-currencies
$ cd dj-currencies/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 dj_currencies tests
$ python runtests.py
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

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

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

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

The pull request should include tests.
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.
The pull request should work for Python 3.8+. Ensure builds are passing on GitHub.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_dj_currencies

History¶

0.0.1 (2018-04-23)¶

First release on PyPI.

1.0.1 (2020-03-09)¶

Added Django 3.1 Support.

1.1.0 (2022-01-17)¶

Django 4.0+ support.