ImageKit 技术文档

1. 安装指南

1.1 安装依赖

首先，确保你已经安装了 Pillow 库。如果你已经在使用 Django 的 ImageField，那么你应该已经安装了 Pillow。

pip install Pillow

1.2 安装 ImageKit

使用 pip 安装 django-imagekit：

pip install django-imagekit

1.3 配置 Django 项目

在 Django 项目的 settings.py 文件中，将 'imagekit' 添加到 INSTALLED_APPS 列表中：

INSTALLED_APPS = [
    ...
    'imagekit',
    ...
]

2. 项目的使用说明

2.1 定义图像规格（Specs）

2.1.1 在模型中定义图像规格

你可以在模型中使用 ImageSpecField 来定义图像规格。例如：

from django.db import models
from imagekit.models import ImageSpecField
from imagekit.processors import ResizeToFill

class Profile(models.Model):
    avatar = models.ImageField(upload_to='avatars')
    avatar_thumbnail = ImageSpecField(source='avatar',
                                      processors=[ResizeToFill(100, 50)],
                                      format='JPEG',
                                      options={'quality': 60})

在这个例子中，avatar_thumbnail 是一个基于 avatar 字段的缩略图，宽度为 100，高度为 50，格式为 JPEG，质量为 60。

2.1.2 使用 ProcessedImageField

如果你不需要保留原始图像，可以使用 ProcessedImageField：

from django.db import models
from imagekit.models import ProcessedImageField
from imagekit.processors import ResizeToFill

class Profile(models.Model):
    avatar_thumbnail = ProcessedImageField(upload_to='avatars',
                                           processors=[ResizeToFill(100, 50)],
                                           format='JPEG',
                                           options={'quality': 60})

2.2 在模板中使用图像规格

2.2.1 使用 generateimage 标签

你可以在模板中使用 generateimage 标签来生成图像：

{% load imagekit %}

{% generateimage 'myapp:thumbnail' source=source_file %}

2.2.2 使用 thumbnail 标签

ImageKit 还提供了 thumbnail 标签，用于生成缩略图：

{% load imagekit %}

{% thumbnail '100x50' source_file %}

3. 项目API使用文档

3.1 定义图像规格类

你可以定义一个图像规格类，并在需要时使用它：

from imagekit import ImageSpec
from imagekit.processors import ResizeToFill

class Thumbnail(ImageSpec):
    processors = [ResizeToFill(100, 50)]
    format = 'JPEG'
    options = {'quality': 60}

3.2 使用图像规格类

你可以直接使用定义的图像规格类来处理图像：

source_file = open('/path/to/myimage.jpg', 'rb')
image_generator = Thumbnail(source=source_file)
result = image_generator.generate()

4. 项目安装方式

4.1 使用 pip 安装

你可以通过 pip 安装 django-imagekit：

pip install django-imagekit

4.2 配置 Django 项目

在 Django 项目的 settings.py 文件中，将 'imagekit' 添加到 INSTALLED_APPS 列表中：

INSTALLED_APPS = [
    ...
    'imagekit',
    ...
]

通过以上步骤，你就可以成功安装并使用 ImageKit 来处理图像了。