Skip to main content

Handle opensearch.xml

Project description

GitHub Coverage License Version Supported Python version Supported Django version Package format Python wheel support Package status

django-opensearch is a Django reusable application to handle opensearch.xml


  • Obtain your copy of source code from the git repository: $ git clone Or download the latest release from

  • Run $ python ./ install from the repository source tree or unpacked archive. Or use pip: $ pip install django-opensearch.


  • Add "opensearch" to settings.INSTALLED_APPS.


  • Add "opensearch" to your URLs definitions.


from django.urls import re_path

urlpatterns += [
    re_path(r"^opensearch/", include("opensearch.urls")),


Load "opensearch_tags" to your base template and place opensearch rel meta tag to <head> HTML tag by calling {% opensearch_meta %}.

{# base.html #}

{% load opensearch_tags %}

    {% opensearch_meta %}



Contains an email address at which the maintainer of the description document can be reached. Defaults to "".


Contains a brief human-readable title that identifies this search engine. Defaults to "".


Contains a human-readable text description of the search engine. Defaults to "".


Contains width of an image that can be used in association with this search content. Defaults to 16.


Contains height of an image that can be used in association with this search content. Defaults to 16.


Contains mimetype of an image that can be used in association with this search content. Defaults to "image/x-icon".


Contains a URL that identifies the location of an image that can be used in association with this search content. Defaults to "favicon.ico".


Contains a Django URL name to search content. Defaults to "search".


Contains the querystring to prepend to search parameter. Defaults to "q=".


Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. Defaults to "UTF-8".


  1. Fork it

  2. Install GNU Make

  3. Install and configure pyenv and pyenv-virtualenv plugin

  4. Install and configure direnv

  5. Create environment config from example

cp .env.example .env
  1. Install development dependencies:

make install
  1. Create your fix/feature branch:

git checkout -b my-new-fix-or-feature
  1. Check code style and moreover:

make check
  1. Run tests:

make test
  1. Push to the branch:

git push origin my-new-fix-or-feature
  1. Create a new Pull Request


django-opensearch is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For complete license text see COPYING file.


Project Website:

Author: Alexei Andrushievich <>

For other authors list see AUTHORS file.

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution (34.5 kB view hashes)

Uploaded Source

Built Distribution

django_opensearch-0.20.0-py3-none-any.whl (22.9 kB view hashes)

Uploaded Python 3

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