Django app to integrate Wrapper for The Central Bank of the Russian Federation site API with your project
Project description
django-cbrf
Приложение для удобной работы с валютами и курсами валют от ЦБ РФ
Установка
Для запуска необходимы:
- Python >= 3
- Django >= 3.8
- cbrf
Установка из PyPI:
pip install django-cbrf
Версия для разработчиков:
git clone https://github.com/egregors/django-cbrf.git
cd django-cbrf
pip install -e .
Запуск тестов:
cd django-cbrf/tests
python manage.py test test_app
Настройки
Добавить приложение в INSTALLED_APPS
:
INSTALLED_APPS = (
# ...
'django_cbrf',
)
Доступные настройки:
# your settings.py
# приложение, где находятся собственные модели
# (опционально, по умолчанию "django_cbrf")
CBRF_APP_NAME = 'test_app'
# количество дней, для заполнения БД (будут получены котировки за последние CBRF_DAYS_FOR_POPULATE дней
# (опционально, по умолчанию 60 дней)
CBRF_DAYS_FOR_POPULATE = 30
Пакет содержит готовые для использования модели Currency
и Record
в модуле django_cbrf.models
, но вы можите
также использовать свои собственные модели, наследовав их от AbstractCurrency
и AbstractRecord
из django_cbrf.abstract_models
.
Для использования собственных моделей необходимо в настройках указать приложение, в моделях которого находятся модели для валют и курсов:
Важно!
Ваши собственные модели для валют и курсов должны называться точно Currency
и Record
Команды manage.py
Загрузка валют
Для того, что бы загрузить перечень существующих валют можно выполнить команду:
python manage.py load_currency
в случае, если в БД нет ни одной записи модели Currency
, эти записи будут загружены через API ЦБ.
Для загружки валют независимо от условий, используйте флаг --force
Загрузка курсов
Чтобы загрузить историю курсов за указанное время необходимо выолнить команду load_rates
.
В качестве параметров команда принимает перечень ISO кодов нужных валют, и опционально, количество
дней за которые необходимо получить курсы. Например, для загрузки в БД историии курсов Доллара США и Евро
за последние 90 дней необходимо выполнить:
python manage.py load_rates usd eur --days 90
Контрибьютинг
Сообщения об ошибках, исправления и новый функционал всегда преветствуются. Открывайте issues, пуште пул реквесты.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_cbrf-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a9d0fd6e6f4a20ca4b61ae8d0a0b83d0df676123f97edb458ac68fc275225f3 |
|
MD5 | 80e7dbcb2d8175109d117c009604ec38 |
|
BLAKE2b-256 | 7af9c273554570f2c0a768b576d90591ea49d50154629f40b056133e390ae014 |