Skip to main content

A super simple Django-whoosh search engine

Project description

Djoosh is a very simple search engine for your Django projects.

WARNING: This is currently under heavy development, so use at your work risk!


  1. Install with pip:

    pip install djoosh

  2. Add djoosh to INSTALLED_APPS in your

  3. In your add:

    from djoosh import SearchMixin
    class BlogPost(models.Model, SearchMixin):

    Note SearchMixin in the parents for MyModel. Just add it to any model that you want to search.

  4. When you’re done, run python search rebuild

  5. That’s it! You can now search your blog posts using'some query'),

    For example you can create a view like this:

    def search(request):
            query = request.GET.get('q', '')
            posts =
            return render_to_response('search_posts.html',
                                      {'posts': posts, 'query': query})

    … and your template can be:

    <form action="/search" method="get">
            <input type="text" name="q" value="{{ query }}" />
            <input type="submit" value="Search Blogs" />
    <h1>Search Results</h1>
    {% for post in posts %}
            <h2>{{ post.title }}</h2>
            <p>{{ post.content }}</p>
    {% endfor %}


Coming soon…

For the impatient:


from blog import BlogPost
from djoosh import site, SearchModel

class BlogPostSearch(SearchModel):
        model = BlogPost
        fields = ('title', 'tags')
        keywords = ('tags',)
        pk = 'id'

site.register(BlogPost, BlogPostSearch)

You may also have a look at djoosh.loading, particularly site and SearchModel.

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Source Distribution

djoosh-0.1.tar.gz (4.2 kB view hashes)

Uploaded source

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