Skip to main content

An app for integrating Celery with Haystack.

Project description


.. image::
:alt: Build Status

This Django app allows you to utilize Celery for automatically updating and
deleting objects in a Haystack_ search index.


* Django 1.8+
* Haystack_ `2.X`_
* Celery_ 3.X

You also need to install your choice of one of the supported search engines
for Haystack and one of the supported backends for Celery.

.. _Haystack:
.. _Celery:


Use your favorite Python package manager to install the app from PyPI, e.g.::

pip install celery-haystack

For Django < 1.9 you need to install and configure `django-transaction-hooks`_ -- an app that
brings transaction commit hooks to Django.

.. _django-transaction-hooks:


1. Add ``'celery_haystack'`` to the ``INSTALLED_APPS`` setting

.. code:: python

# ..

2. Enable the celery-haystack signal processor in the settings

.. code:: python

HAYSTACK_SIGNAL_PROCESSOR = 'celery_haystack.signals.CelerySignalProcessor'

3. Alter all of your ``SearchIndex`` subclasses to inherit from
``celery_haystack.indexes.CelerySearchIndex`` and

.. code:: python

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. Ensure your Celery instance is running.


This app is a blatant rip-off of Daniel Lindsley's queued_search_
app but uses Ask Solem Hoel's Celery_ instead of the equally awesome
queues_ library by Matt Croyden.

.. _queued_search:
.. _Celery:
.. _queues:


Please use the `Github issue tracker`_ for any bug reports or feature

.. _`Github issue tracker`:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

celery-haystack-0.10.tar.gz (8.3 kB view hashes)

Uploaded source

Built Distribution

celery_haystack-0.10-py2.py3-none-any.whl (12.1 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page