Installation

1. Install or add django-googlesearch to your Python path.

2. Add googlesearch to your INSTALLED_APPS setting.

3. Add a GOOGLE_SEARCH_PARTNER_ID setting to your project's settings.py file. This setting specifies the Google Custom Search Engine ID to use when rendering the Google search box, as provided by Google, i.e.:

   GOOGLE_SEARCH_PARTNER_ID = 'partner-pub-329847239847234:xcvx-3kasd'
   

4. Add googlesearch url include to your project's urls.py file:

   (r'^search/', include('googlesearch.urls')),
   

5. Optionally add "django.core.context_processors.request", to your TEMPLATE_CONTEXT_PROCESSORS setting, i.e.:

   TEMPLATE_CONTEXT_PROCESSORS = (
       "django.core.context_processors.request",
       ...other processors...
   )
   

   We need a request object when rendering the search input field and results to be able to display the search query value. This is optional and is not required for operation but is highly recommended.

Usage

Once installed you can add a Google search box to your templates by using the googlesearch_input template tag, i.e.:

{% load googlesearch_inclusion_tags %}

...some html...

{% googlesearch_input %}

...some more html...

By default search results are displayed through the view with URL named googlesearch_results, as defined in googlesearch.urls. You can create your own URL named googlesearch_results and include the googlesearch_results template tag in its template to display results, i.e.:

{% load googlesearch_inclusion_tags %}

...some html...

{% googlesearch_results %}

...some more html...

Praekelt Foundation

• Shaun Sephton

0.0.5 (2011-08-11)

1. Refactor to not use django-preferences.
2. Documentation.