Django-Gravatar 技术文档

1. 安装指南

1.1 通过 PyPi 安装

你可以通过 PyPi 直接安装 django-gravatar2：

pip install django-gravatar2

1.2 通过 GitHub 安装

你也可以直接从 GitHub 安装：

pip install git+git://github.com/twaddington/django-gravatar.git#egg=DjangoGravatar

1.3 配置 Django 项目

安装完成后，在 Django 项目的 settings.py 文件中添加 django_gravatar 到 INSTALLED_APPS：

INSTALLED_APPS = (
    # ...
    'django_gravatar',
)

2. 项目的使用说明

2.1 在代码中使用

django-gravatar 提供了一些辅助方法，可以在代码中直接使用：

from django_gravatar.helpers import get_gravatar_url, has_gravatar, get_gravatar_profile_url, calculate_gravatar_hash

# 获取 Gravatar 图片 URL
url = get_gravatar_url('[e-mail]', size=150)

# 检查邮箱是否有 Gravatar
gravatar_exists = has_gravatar('[e-mail]')

# 获取 Gravatar 个人资料 URL
profile_url = get_gravatar_profile_url('[e-mail]')

# 计算 Gravatar 哈希值
email_hash = calculate_gravatar_hash('[e-mail]')

2.2 在模板中使用

在 Django 模板中，你可以使用 gravatar 模板标签来生成 Gravatar 图片或 URL：

{% load gravatar %}

<!-- 生成 Gravatar URL -->
{% gravatar_url user.email 150 %}

<!-- 生成 Gravatar 图片 -->
{% gravatar user.email 150 %}

<!-- 生成带有 alt 文本的 Gravatar 图片 -->
{% gravatar user.email 150 "[e-mail]" %}

<!-- 生成 Gravatar 个人资料 URL -->
{% gravatar_profile_url user.email %}

3. 项目 API 使用文档

3.1 get_gravatar_url(email, size=None, default=None, rating=None, secure=None)

• 功能: 获取 Gravatar 图片的 URL。
• 参数:
  • email: 用户的邮箱地址。
  • size: 图片大小（像素），默认为 GRAVATAR_DEFAULT_SIZE。
  • default: 默认图片 URL 或类型，默认为 GRAVATAR_DEFAULT_IMAGE。
  • rating: 图片评级，默认为 GRAVATAR_DEFAULT_RATING。
  • secure: 是否使用 HTTPS，默认为 GRAVATAR_DEFAULT_SECURE。
• 返回值: Gravatar 图片的 URL。

3.2 has_gravatar(email)

• 功能: 检查邮箱是否有 Gravatar。
• 参数:
  • email: 用户的邮箱地址。
• 返回值: 布尔值，表示是否存在 Gravatar。

3.3 get_gravatar_profile_url(email)

• 功能: 获取 Gravatar 个人资料的 URL。
• 参数:
  • email: 用户的邮箱地址。
• 返回值: Gravatar 个人资料的 URL。

3.4 calculate_gravatar_hash(email)

• 功能: 计算邮箱的 Gravatar 哈希值。
• 参数:
  • email: 用户的邮箱地址。
• 返回值: 邮箱的 Gravatar 哈希值。

4. 项目配置

你可以在 settings.py 中配置以下选项：

GRAVATAR_URL = 'http://www.gravatar.com/'  # Gravatar 基础 URL
GRAVATAR_SECURE_URL = 'https://secure.gravatar.com/'  # Gravatar 基础 HTTPS URL
GRAVATAR_DEFAULT_SIZE = 80  # Gravatar 图片默认大小
GRAVATAR_DEFAULT_IMAGE = 'mm'  # 默认图片类型或 URL
GRAVATAR_DEFAULT_RATING = 'g'  # 默认图片评级
GRAVATAR_DEFAULT_SECURE = True  # 默认是否使用 HTTPS

5. 贡献指南

如果你有兴趣为 django-gravatar 贡献代码，欢迎在 GitHub 上 fork 项目并提交 Pull Request。在提交之前，请确保运行了测试：

cd example_project
./manage.py test django_gravatar

通过以上文档，你应该能够顺利安装、配置并使用 django-gravatar 项目。如果你有任何问题或建议，欢迎参与项目的贡献。