Celery-Haystack 技术文档

1. 安装指南

首先，确保你的环境中已经安装了以下依赖：

• Django 1.8 或更高版本
• Haystack 2.X 版本
• Celery 3.X 版本

还需要安装 Haystack 支持的搜索引擎以及 Celery 支持的后端。

使用你喜欢的 Python 包管理器，例如 pip，从 PyPI 安装 Celery-Haystack：

pip install celery-haystack

对于 Django 1.9 以下版本，需要安装并配置 django-transaction-hooks 应用，它可以为 Django 提供事务提交钩子功能。

2. 项目的使用说明

要使用 Celery-Haystack，请按照以下步骤操作：

1. 在 Django 的 INSTALLED_APPS 设置中添加 'celery_haystack'：

   INSTALLED_APPS = [
       # ..
       'celery_haystack',
   ]
   

2. 在设置中启用 celery-haystack 的信号处理器：

   HAYSTACK_SIGNAL_PROCESSOR = 'celery_haystack.signals.CelerySignalProcessor'
   

3. 将所有 SearchIndex 子类更改为继承自 celery_haystack.indexes.CelerySearchIndex 和 haystack.indexes.Indexable：

   from haystack import indexes
   from celery_haystack.indexes import CelerySearchIndex
   from myapp.models import Note
   
   class NoteIndex(CelerySearchIndex, indexes.Indexable):
       text = indexes.CharField(document=True, model_attr='content')
   
       def get_model(self):
           return Note
   

4. 确保你的 Celery 实例正在运行。

3. 项目API使用文档

目前 Celery-Haystack 的文档中没有明确列出 API 使用文档。但是，根据其设计，主要的功能是通过信号处理器和索引类的继承来实现异步索引更新和删除。具体使用时应参考 Haystack 和 Celery 的官方文档，并结合 Celery-Haystack 的源代码来深入了解其工作原理。

4. 项目安装方式

如前所述，项目可以通过 Python 的包管理器 pip 安装：

pip install celery-haystack

如果需要从源代码安装，可以克隆 Git 仓库然后使用 setup.py 进行安装：

git clone https://github.com/django-haystack/celery-haystack.git
cd celery-haystack
python setup.py install

请确保所有依赖都已正确安装，否则项目可能无法正常运行。