Skip to main content

Elasticsearch client with Django support.

Project description

Gum is a Django app for integrate Elasticsearch 1.x with Django. You can find documentation at Documentation Status

Quick start

1 Install using pip:

pip install django-gum

2 Add “gum” to your INSTALLED_APPS settings like this:

INSTALLED_APPS += ('gum',)

3 Add Elasticsearch configuration to your settings like this:


List of available configuration variables:

  • GUM_DEBUG (boolean)
  • GUM_USE_CELERY (boolean)

4 Create an in your app, with a content like this:

from gum.indexer import MappingType, indexer

class PostMappingType(MappingType):

    def document(self, instance):
        tags_text = " ".join(map(lambda x: x.label, instance.tags.all()))
        return {
            "title": instance.title,
            "content": instance.content,
            "text": "{} {} {}".format(instance.title, instance.content, tags_text)

    def mapping(self):
        return {
            "properties": {
                "title": {
                    "type": "string",
                    "store": True,
                "content": {
                    "type": "string",
                    "store": True,
                "text": {
                    "type": "string",
                    "store": True,

indexer.register(Post, PostMappingType)

5 Update Elasticsearch index:

./ gum --update-index

You can specify the models you want to index:

./ gum --update-index blog.Post


You can perform Elasticsearch searches (accessing search method) using elasticsearch model attribute:

response ={
    "query": {
        "match_all": {}

Project details

Download files

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

Files for django-gum, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size django-gum-2.0.2.tar.gz (20.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page