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
Install GNU Make
Install and configure pyenv and pyenv-virtualenv plugin
Install and configure direnv
Create environment config from example
cp .env.example .envInstall development dependencies:
make installCreate your fix/feature branch:
git checkout -b my-new-fix-or-featureCheck code style and moreover:
make checkRun tests:
make testPush to the branch:
git push origin my-new-fix-or-featureLicensing
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.
Source Distribution
Built Distribution
File details
Details for the file django-opensearch-0.20.0.zip.
File metadata
- Download URL: django-opensearch-0.20.0.zip
- Upload date:
- Size: 34.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce86acea069a0d6e9f6ec296b8d92ac2b8c68451884499703775c42c9fe679ed |
|
| MD5 | 557ca919dfda514e6acde6b6152bafe6 |
|
| BLAKE2b-256 | 449819e7b3d5c3e5500d442cf681bf3a93dde6e0a30a6fea368effb82ff4b457 |
File details
Details for the file django_opensearch-0.20.0-py3-none-any.whl.
File metadata
- Download URL: django_opensearch-0.20.0-py3-none-any.whl
- Upload date:
- Size: 22.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 670660f60d906fc9ca86c983e80489f7e5ebad19bfe5c63aa3a9b44fff73cd9e |
|
| MD5 | 7ee8bbb81ec7a544c7b8004c4135164a |
|
| BLAKE2b-256 | de0b6fa138b681e52590c0d548ea3ac4b662716bb00894c6a635ececddaf5455 |
