معرفی شرکت ها
django-opensearch-0.9.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Handle opensearch.xml
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-opensearch-0.9.1 |
| نام | django-opensearch |
| نسخه کتابخانه | 0.9.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Alexei Andrushievich |
| ایمیل نویسنده | vint21h@vint21h.pp.ua |
| آدرس صفحه اصلی | https://github.com/vint21h/django-opensearch/ |
| آدرس اینترنتی | https://pypi.org/project/django-opensearch/ |
| مجوز | GPLv3+ |
.. django-opensearch
.. README.rst
A django-opensearch documentation
=================================
|GitHub|_ |Coveralls|_ |pypi-license|_ |pypi-version|_ |pypi-python-version|_ |pypi-django-version|_ |pypi-format|_ |pypi-wheel|_ |pypi-status|_
*django-opensearch is a Django reusable application to handle opensearch.xml*
.. contents::
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``.
.. code-block:: python
# settings.py
INSTALLED_APPS += [
"opensearch",
]
* Add ``"opensearch"`` to your URLs definitions.
.. code-block:: python
# 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 %}``.
.. code-block:: django
{# 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
------------
1. `Fork it <https://github.com/vint21h/django-opensearch/>`_
2. Install `GNU Make <https://www.gnu.org/software/make/>`_
3. Install and configure `pyenv <https://github.com/pyenv/pyenv/>`_ and `pyenv-virtualenv plugin <https://github.com/pyenv/pyenv-virtualenv/>`_
4. Install and configure `direnv <https://github.com/direnv/direnv/>`_
5. Create environment config from example
.. code-block:: bash
cp .env.example .env
6. Install development dependencies:
.. code-block:: bash
make install
7. Create your fix/feature branch:
.. code-block:: bash
git checkout -b my-new-fix-or-feature
8. Check code style and moreover:
.. code-block:: bash
make check
9. Run tests:
.. code-block:: bash
make test
10. Push to the branch:
.. code-block:: bash
git push origin my-new-fix-or-feature
11. `Create a new Pull Request <https://github.com/vint21h/django-opensearch/compare/>`_
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.
.. |GitHub| image:: https://github.com/vint21h/django-opensearch/workflows/build/badge.svg
:alt: GitHub
.. |Coveralls| image:: https://coveralls.io/repos/github/vint21h/django-opensearch/badge.svg?branch=master
:alt: Coverage
.. |pypi-license| image:: https://img.shields.io/pypi/l/django-opensearch
:alt: License
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-opensearch
:alt: Version
.. |pypi-django-version| image:: https://img.shields.io/pypi/djversions/django-opensearch
:alt: Supported Django version
.. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/django-opensearch
:alt: Supported Python version
.. |pypi-format| image:: https://img.shields.io/pypi/format/django-opensearch
:alt: Package format
.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/django-opensearch
:alt: Python wheel support
.. |pypi-status| image:: https://img.shields.io/pypi/status/django-opensearch
:alt: Package status
.. _GitHub: https://github.com/vint21h/django-opensearch/actions/
.. _Coveralls: https://coveralls.io/github/vint21h/django-opensearch?branch=master
.. _pypi-license: https://pypi.org/project/django-opensearch/
.. _pypi-version: https://pypi.org/project/django-opensearch/
.. _pypi-django-version: https://pypi.org/project/django-opensearch/
.. _pypi-python-version: https://pypi.org/project/django-opensearch/
.. _pypi-format: https://pypi.org/project/django-opensearch/
.. _pypi-wheel: https://pypi.org/project/django-opensearch/
.. _pypi-status: https://pypi.org/project/django-opensearch/
نیازمندی
| مقدار | نام |
|---|---|
| <4.1,>=2.2 | django |
| >=1.0.3 | django-appconf |
| ==21.4.0 | attrs |
| ==1.7.2 | bandit |
| ==22.1.0 | black |
| ==0.22.1 | bpython |
| ==0.47 | check-manifest |
| ==0.3.4 | check-wheel-contents |
| ==6.3.1 | coverage |
| ==3.3.1 | coveralls |
| ==0.13.0 | curlylint |
| ==1.8.1 | darglint |
| ==0.9 | dennis |
| ==1.9.0 | django-stubs |
| ==0.12.0 | dlint |
| ==0.2.1 | dodgy |
| ==0.3.0 | dotenv-linter |
| ==0.0.6 | flake8-annotations-complexity |
| ==0.0.5 | flake8-annotations-coverage |
| ==0.4.0 | flake8-broken-line |
| ==22.1.11 | flake8-bugbear |
| ==1.5.3 | flake8-builtins |
| ==1.3.2 | flake8-coding |
| ==0.1.0 | flake8-cognitive-complexity |
| ==3.8.0 | flake8-comprehensions |
| ==4.0.0 | flake8-debugger |
| ==1.1.2 | flake8-django |
| ==1.6.0 | flake8-docstrings |
| ==1.2.0 | flake8-eradicate |
| ==2.1.1 | flake8-executable |
| ==0.0.9 | flake8-expression-complexity |
| ==1.1.1 | flake8-fixme |
| ==0.0.6 | flake8-functions |
| ==1.2.0 | flake8-mutable |
| ==0.3.3 | flake8-no-implicit-concat |
| ==4.0.0 | flake8-print |
| ==1.1.3 | flake8-return |
| ==0.17.1 | flake8-simplify |
| ==1.12.0 | flake8-typing-imports |
| ==1.3 | flake8-use-fstring |
| ==0.0.4 | flake8-variables-names |
| ==3.9.2 | flake8 |
| ==4.11.1 | importlib-metadata |
| ==1.5.0 | interrogate |
| ==5.10.1 | isort |
| ==0.931 | mypy |
| ==0.12.1 | pep8-naming |
| ==0.5.0 | pip-outdated |
| ==0.4 | polint |
| ==4.1.0 | pre-commit-hooks |
| ==2.17.0 | pre-commit |
| ==2.11.2 | pygments |
| ==2.5.2 | pylint-django |
| ==2.12.2 | pylint |
| ==3.2 | pyroma |
| ==3.0.0 | pytest-cov |
| ==4.5.2 | pytest-django |
| ==0.1.3 | pytest-extra-durations |
| ==0.4.2 | pytest-instafail |
| ==0.9.4 | pytest-sugar |
| ==0.0.11 | pytest-timer[termcolor] |
| ==7.0.1 | pytest |
| ==32.0 | readme-renderer |
| ==1.3.1 | removestar |
| ==2.2.0 | seed-isort-config |
| ==0.8.9 | tabulate |
| ==2.9.1 | tox-gh-actions |
| ==1.1.0 | tox-pyenv |
| ==3.24.5 | tox |
| ==3.8.0 | twine |
| ==0.37.1 | wheel |
| ==1.3.0 | yesqa |
نحوه نصب
نصب پکیج whl django-opensearch-0.9.1:
pip install django-opensearch-0.9.1.whl
نصب پکیج tar.gz django-opensearch-0.9.1:
pip install django-opensearch-0.9.1.tar.gz