Metadata-Version: 1.0
Name: django-googlesearch
Version: 0.0.5
Summary: Django Google custom search engine app.
Home-page: http://github.com/praekelt/django-googlesearch
Author: Praekelt Foundation
Author-email: dev@praekelt.com
License: BSD
Description: Django Google Search
        ====================
        **Django Google custom search engine app.**
        
        Provides a simple tag rendering a Google Custom Search Engine input field and a view displaying search results.
        
        .. contents:: Contents
            :depth: 5
        
        Installation
        ------------
        
        #. Install or add ``django-googlesearch`` to your Python path.
        
        #. Add ``googlesearch`` to your ``INSTALLED_APPS`` setting.
        
        #. 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'
        
        #. Add googlesearch url include to your project's ``urls.py`` file::
        
            (r'^search/', include('googlesearch.urls')),
        
        #. 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...
        
        Authors
        =======
        
        Praekelt Foundation
        -------------------
        * Shaun Sephton
        
        Changelog
        =========
        
        0.0.5 (2011-08-11)
        ------------------
        #. Refactor to not use django-preferences.
        #. Documentation.
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
