Handle opensearch.xml
Project description
django-opensearch is a Django reusable application to handle opensearch.xml
Installation
- Obtain your copy of source code from the git repository: $ git clone https://github.com/vint21h/django-opensearch.git. Or download the latest release from https://github.com/vint21h/django-opensearch/tags/.
- Run $ python ./setup.py install from the repository source tree or unpacked archive. Or use pip: $ pip install django-opensearch.
Configuration
- Add "opensearch" to settings.INSTALLED_APPS.
# settings.py INSTALLED_APPS += [ "opensearch", ]
- Add "opensearch" to your URLs definitions.
# urls.py from django.urls import re_path urlpatterns += [ re_path(r"^opensearch/", include("opensearch.urls")), ]
Usage
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 %} <head> {% opensearch_meta %} </head>
Settings
- OPENSEARCH_CONTACT_EMAIL
- Contains an email address at which the maintainer of the description document can be reached. Defaults to "".
- OPENSEARCH_SHORT_NAME
- Contains a brief human-readable title that identifies this search engine. Defaults to "".
- OPENSEARCH_DESCRIPTION
- Contains a human-readable text description of the search engine. Defaults to "".
- OPENSEARCH_FAVICON_WIDTH
- Contains width of an image that can be used in association with this search content. Defaults to 16.
- OPENSEARCH_FAVICON_HEIGHT
- Contains height of an image that can be used in association with this search content. Defaults to 16.
- OPENSEARCH_FAVICON_TYPE
- Contains mimetype of an image that can be used in association with this search content. Defaults to "image/x-icon".
- OPENSEARCH_FAVICON_FILE
- Contains a URL that identifies the location of an image that can be used in association with this search content. Defaults to "favicon.ico".
- OPENSEARCH_SEARCH_URL
- Contains a Django URL name to search content. Defaults to "search".
- OPENSEARCH_SEARCH_QUERYSTRING
- Contains the querystring to prepend to search parameter. Defaults to "q=".
- OPENSEARCH_INPUT_ENCODING
- Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. Defaults to "UTF-8".
Contributing
- Fork it
- Install GNU Make
- Install and configure pyenv and pyenv-virtualenv plugin
- Install and configure direnv
- Create environment config from example
cp .env.example .env
- Install development dependencies:
make install
- Create your fix/feature branch:
git checkout -b my-new-fix-or-feature
- Check code style and moreover:
make check
- Run tests:
make test
- Push to the branch:
git push origin my-new-fix-or-feature
Licensing
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.
Contacts
Project Website: https://github.com/vint21h/django-opensearch/
Author: Alexei Andrushievich <vint21h@vint21h.pp.ua>
For other authors list see AUTHORS file.
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.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size django_opensearch-0.19.1-py3-none-any.whl (22.9 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
| Filename, size django-opensearch-0.19.1.zip (34.6 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for django_opensearch-0.19.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3b3ffaccb4e191f04d7687f82289ab2db1c7c59198448a9fce0c751c16a166c4 |
|
| MD5 | 3922e3cb960f666dc94c4994c526ea50 |
|
| BLAKE2-256 | f1bf28ceba09b6af87585ca506187921f4ab1b7ea7120d7b6cf4ef5fb8d60a82 |