Django 缩略图生成库 sorl-thumbnail 技术文档

1. 安装指南

sorl-thumbnail 是一个适用于 Django 的图片缩略图生成库。要安装最新版本的 sorl-thumbnail，请使用 pip 命令：

pip install sorl-thumbnail

确保你的项目环境已经安装了 pip 和 Django。

2. 项目的使用说明

sorl-thumbnail 可以通过多种方式进行使用，包括模板标签、模型字段和低级别 API。

模板使用

首先，在你的模板中加载缩略图模板标签：

{% load thumbnail %}

然后，使用以下示例代码生成缩略图：

{% thumbnail item.image "100x100" crop="center" as im %}
    <img src="{{ im.url }}" width="{{ im.width }}" height="{{ im.height }}">
{% endthumbnail %}

模型使用

如果你的 Django 版本低于或等于 1.2.5，可以使用自动删除缩略图的 ImageField：

from django.db import models
from sorl.thumbnail import ImageField

class Item(models.Model):
    image = ImageField(upload_to='whatever')

低级别 API 使用

可以使用 get_thumbnail 和 delete 函数：

from sorl.thumbnail import get_thumbnail
from sorl.thumbnail import delete

im = get_thumbnail(my_file, '100x100', crop='center', quality=99)
delete(my_file)

3. 项目API使用文档

sorl-thumbnail 提供了丰富的 API 以供开发者使用。

• get_thumbnail(source, geometry, **options): 生成一个指定尺寸的缩略图。
• delete(source): 删除指定图片的所有缩略图。
• delete_all(): 删除所有缩略图。

更多 API 使用示例，请参考官方文档中的相关章节。

4. 项目安装方式

sorl-thumbnail 可以通过以下步骤集成到你的 Django 项目中：

1. 将 'sorl.thumbnail' 添加到你的项目的 INSTALLED_APPS 设置中：

INSTALLED_APPS = [
    # 其他应用
    'sorl.thumbnail',
]

2. 根据需要配置 sorl-thumbnail 的相关设置，如缩略图的存储位置等。

3. 在模板、模型或代码中使用 sorl-thumbnail 功能。

通过遵循上述步骤，你可以轻松地将 sorl-thumbnail 集成到你的 Django 项目中，并开始生成和管理图片缩略图。