Django-Money 项目技术文档

1. 安装指南

安装方式

使用pip进行安装：

$ pip install django-money

此命令会自动安装py-moneyed v1.2或更高版本。

在项目的INSTALLED_APPS中添加djmoney。这是必需的，以确保金额字段在管理后台中正确显示。

INSTALLED_APPS = [
    ...,
    'djmoney',
    ...
]

2. 项目的使用说明

模型使用

将MoneyField作为模型字段使用：

from djmoney.models.fields import MoneyField
from django.db import models

class BankAccount(models.Model):
    balance = MoneyField(max_digits=14, decimal_places=2, default_currency='USD')

您还可以设置MoneyField为可空（null=True），并指定默认货币为None。

查询模型

可以通过金额字段进行模型查询：

from djmoney.money import Money

account = BankAccount.objects.create(balance=Money(10, 'USD'))
swissAccount = BankAccount.objects.create(balance=Money(10, 'CHF'))

BankAccount.objects.filter(balance__gt=Money(1, 'USD'))
# 将返回account对象

字段验证

支持三种字段验证方式：按金额的数值部分验证、按单一金额验证和按多金额验证。

添加新货币

在settings.py中添加以下代码以添加新货币：

import moneyed

BOB = moneyed.add_currency(
    code='BOB',
    numeric='068',
    name='玻利维亚诺',
    countries=('玻利维亚', )
)

管理器注意事项

如果使用自定义模型管理器，需要确保管理器支持金额字段查询。

3. 项目API使用文档

本项目API使用文档请参考官方文档。

4. 项目安装方式

项目安装方式已在“安装指南”部分说明。使用pip安装django-money包即可。

通过上述文档，用户应能详细了解如何安装和使用django-money项目，以及如何进行API调用和进行货币字段的验证等高级操作。