├── .editorconfig ├── .env.example ├── .envrc ├── .gitattributes ├── .github ├── CODEOWNERS ├── ISSUE_TEMPLATE.md ├── PULL_REQUEST_TEMPLATE.md ├── SECURITY.md ├── config.yml ├── dependabot.yml └── workflows │ ├── build.yml │ ├── check-requirements.yml │ ├── check.yml │ ├── coveralls.yml │ └── test.yml ├── .gitignore ├── .pre-commit-config.yaml ├── .python-version ├── AUTHORS ├── COPYING ├── MANIFEST.in ├── Makefile ├── README.rst ├── opensearch ├── __init__.py ├── apps.py ├── conf.py ├── locale │ ├── en │ │ └── LC_MESSAGES │ │ │ ├── django.mo │ │ │ └── django.po │ └── uk │ │ └── LC_MESSAGES │ │ ├── django.mo │ │ └── django.po ├── templates │ └── opensearch │ │ ├── opensearch.xml │ │ └── templatetags │ │ └── opensearch_meta.html ├── templatetags │ ├── __init__.py │ └── opensearch_tags.py ├── urls.py └── views.py ├── setup.cfg ├── setup.py └── tests ├── __init__.py ├── settings.py ├── templatetags ├── __init__.py └── test_opensearch_tags.py └── test_views.py /.editorconfig: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .editorconfig 3 | 4 | 5 | root = true 6 | 7 | 8 | [*] 9 | charset = utf-8 10 | end_of_line = lf 11 | insert_final_newline = true 12 | trim_trailing_whitespace = true 13 | 14 | 15 | [*.py] 16 | indent_style = space 17 | indent_size = 4 18 | 19 | 20 | [Makefile] 21 | indent_style = tab 22 | 23 | 24 | [*.json] 25 | indent_style = space 26 | indent_size = 2 27 | 28 | 29 | [*.{yml,yaml}] 30 | indent_style = space 31 | indent_size = 2 32 | 33 | 34 | [*.ini] 35 | indent_style = space 36 | indent_size = 4 37 | 38 | 39 | [*.cfg] 40 | indent_style = space 41 | indent_size = 4 42 | 43 | 44 | [*.{htm,html}] 45 | indent_style = space 46 | indent_size = 4 47 | -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .env.example 3 | 4 | 5 | NAME=opensearch 6 | COVERALLS_REPO_TOKEN= 7 | TWINE_USERNAME=__token__ 8 | TWINE_PASSWORD= 9 | TEST_TWINE_PASSWORD= 10 | -------------------------------------------------------------------------------- /.envrc: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .envrc 3 | 4 | 5 | dotenv 6 | layout python 7 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .gitattributes 3 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/CODEOWNERS 3 | 4 | 5 | * @vint21h 6 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | ## Expected Behavior 8 | 9 | 10 | ## Current Behavior 11 | 12 | 13 | ## Possible Solution 14 | 15 | 16 | ## Steps to Reproduce 17 | 18 | 19 | 1. 20 | 2. 21 | 3. 22 | 23 | ## Context (Environment) 24 | 25 | 26 | 27 | 28 | 29 | ## Detailed Description 30 | 31 | 32 | ## Possible Implementation 33 | 34 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | ## Description 8 | 9 | 10 | ## Related Issue 11 | 12 | 13 | 14 | 15 | ## Motivation and Context 16 | 17 | 18 | 19 | ## How Has This Been Tested? 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /.github/SECURITY.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | # Security Policy 6 | 7 | ## Supported Versions 8 | 9 | So, because this is not a thing that can produce security problems in the project using it, 10 | security policy is very simple: supported only the last major or minor branch. 11 | 12 | | Version | Supported | 13 | |---------|--------------------| 14 | | 0.20.x | :white_check_mark: | 15 | 16 | ## Reporting a Vulnerability 17 | 18 | If you found something that in your opinion may produce any security problem, please create a [new issue](https://github.com/vint21h/django-opensearch/issues/new/). 19 | -------------------------------------------------------------------------------- /.github/config.yml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/config.yml 3 | 4 | 5 | blank_issues_enabled: true 6 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/dependabot.yml 3 | 4 | 5 | version: 2 6 | updates: 7 | - package-ecosystem: "pip" 8 | directory: "/" 9 | schedule: 10 | interval: "daily" 11 | allow: 12 | - dependency-name: "all" 13 | dependency-type: "direct" 14 | - package-ecosystem: "github-actions" 15 | directory: "/" 16 | schedule: 17 | interval: "daily" 18 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # django-mcadmin 2 | # .github/workflows/build.yml 3 | 4 | 5 | name: "build" 6 | on: 7 | push: 8 | branches: 9 | - "*" 10 | tags: 11 | - "*" 12 | pull_request: 13 | branches: 14 | - "*" 15 | workflow_dispatch: 16 | workflow_call: 17 | env: 18 | NAME: "opensearch" 19 | DEFAULT_PYTHON_VERSION: "3.10" 20 | jobs: 21 | check-requirements: 22 | uses: "./.github/workflows/check-requirements.yml" 23 | check: 24 | uses: "./.github/workflows/check.yml" 25 | test: 26 | uses: "./.github/workflows/test.yml" 27 | if: success() 28 | needs: ["check"] 29 | coveralls: 30 | uses: "./.github/workflows/coveralls.yml" 31 | if: success() 32 | needs: ["test", "check"] 33 | -------------------------------------------------------------------------------- /.github/workflows/check-requirements.yml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/workflows/check-requirements.yml 3 | 4 | 5 | name: "check-requirements" 6 | on: 7 | schedule: 8 | - cron: "0 3 * * *" 9 | workflow_dispatch: 10 | workflow_call: 11 | env: 12 | DEFAULT_PYTHON_VERSION: "3.10" 13 | jobs: 14 | check-requirements: 15 | name: "check-requirements" 16 | runs-on: "ubuntu-latest" 17 | steps: 18 | - name: "Git clone" 19 | id: "git-clone" 20 | uses: "actions/checkout@v2" 21 | - name: "Set up Python ${{ env.DEFAULT_PYTHON_VERSION }}" 22 | id: "set-up-python" 23 | uses: "actions/setup-python@v2" 24 | with: 25 | python-version: "${{ env.DEFAULT_PYTHON_VERSION }}" 26 | - name: "Pip cache" 27 | id: "pip-cache" 28 | uses: "actions/cache@v2" 29 | with: 30 | path: "~/.cache/pip" 31 | key: "${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}" 32 | restore-keys: | 33 | "${{ runner.os }}-pip-" 34 | - name: "Install requirements" 35 | id: "install-requirements" 36 | run: "make install" 37 | - name: "Check outdated requirements" 38 | id: "check-outdated-requirements" 39 | continue-on-error: true 40 | run: "pip-outdated" 41 | -------------------------------------------------------------------------------- /.github/workflows/check.yml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/workflows/check.yml 3 | 4 | 5 | name: "check" 6 | on: 7 | workflow_dispatch: 8 | workflow_call: 9 | env: 10 | NAME: "opensearch" 11 | DEFAULT_PYTHON_VERSION: "3.10" 12 | jobs: 13 | check: 14 | name: "${{ matrix.toxenv }}" 15 | runs-on: "ubuntu-latest" 16 | strategy: 17 | matrix: 18 | toxenv: ["check", "check-build"] 19 | steps: 20 | - name: "Git clone" 21 | id: "git-clone" 22 | uses: "actions/checkout@v2" 23 | - name: "Set up Python ${{ env.DEFAULT_PYTHON_VERSION }}" 24 | id: "set-up-python" 25 | uses: "actions/setup-python@v2" 26 | with: 27 | python-version: "${{ env.DEFAULT_PYTHON_VERSION }}" 28 | - name: "Pip cache" 29 | id: "pip-cache" 30 | uses: "actions/cache@v2" 31 | with: 32 | path: "~/.cache/pip" 33 | key: "${{ runner.os }}-pip-${{ matrix.toxenv }}-${{ hashFiles('setup.cfg') }}" 34 | restore-keys: | 35 | "${{ runner.os }}-pip-${{ matrix.toxenv }}-" 36 | "${{ runner.os }}-pip-" 37 | - name: "Pre-commit cache" 38 | id: "pre-commit-cache" 39 | uses: "actions/cache@v2" 40 | with: 41 | path: "~/.cache/pre-commit" 42 | key: "${{ runner.os }}-pre-commit-${{ matrix.toxenv }}-${{ hashFiles('.pre-commit-config.yaml') }}" 43 | restore-keys: | 44 | "${{ runner.os }}-pre-commit-${{ matrix.toxenv }}-" 45 | "${{ runner.os }}-pre-commit-" 46 | - name: "Install requirements" 47 | id: "install-requirements" 48 | run: "make install" 49 | - name: "Run ${{ matrix.toxenv }}" 50 | id: "run" 51 | run: "tox -e ${{ matrix.toxenv }}" 52 | -------------------------------------------------------------------------------- /.github/workflows/coveralls.yml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/workflows/coveralls.yml 3 | 4 | 5 | name: "coveralls" 6 | on: 7 | workflow_dispatch: 8 | workflow_call: 9 | env: 10 | NAME: "opensearch" 11 | DEFAULT_PYTHON_VERSION: "3.10" 12 | jobs: 13 | coveralls: 14 | name: "coveralls" 15 | runs-on: "ubuntu-latest" 16 | steps: 17 | - name: "Git clone" 18 | id: "git-clone" 19 | uses: "actions/checkout@v2" 20 | - name: "Set up Python ${{ env.DEFAULT_PYTHON_VERSION }}" 21 | id: "set-up-python" 22 | uses: "actions/setup-python@v2" 23 | with: 24 | python-version: "${{ env.DEFAULT_PYTHON_VERSION }}" 25 | - name: "Pip cache" 26 | id: "pip-cache" 27 | uses: "actions/cache@v2" 28 | with: 29 | path: "~/.cache/pip" 30 | key: "${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}" 31 | restore-keys: | 32 | "${{ runner.os }}-pip-" 33 | - name: "Temporarily save coverage statistics" 34 | id: "temporarily-save-coverage-statistics" 35 | uses: "actions/cache@v2" 36 | with: 37 | path: ".coverage" 38 | key: ".coverage-${{ github.run_id }}-${{ github.run_number }}" 39 | - name: "Install requirements" 40 | id: "install-requirements" 41 | run: "make install" 42 | - name: "Upload coverage report to Coveralls" 43 | id: "upload-coverage-report-to-coveralls" 44 | env: 45 | GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" 46 | run: "coveralls --service=github" 47 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .github/workflows/test.yml 3 | 4 | 5 | name: "test" 6 | on: 7 | workflow_dispatch: 8 | workflow_call: 9 | env: 10 | NAME: "opensearch" 11 | jobs: 12 | test: 13 | name: "${{ matrix.python-version }}" 14 | runs-on: "ubuntu-latest" 15 | strategy: 16 | matrix: 17 | python-version: ["3.7", "3.8", "3.9", "3.10"] 18 | steps: 19 | - name: "Git clone" 20 | id: "git-clone" 21 | uses: "actions/checkout@v2" 22 | - name: "Set up Python ${{ matrix.python-version }}" 23 | id: "set-up-python" 24 | uses: "actions/setup-python@v2" 25 | with: 26 | python-version: "${{ matrix.python-version }}" 27 | - name: "Pip cache" 28 | id: "pip-cache" 29 | uses: "actions/cache@v2" 30 | with: 31 | path: "~/.cache/pip" 32 | key: "${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.cfg') }}" 33 | restore-keys: | 34 | "${{ runner.os }}-pip-${{ matrix.python-version }}-" 35 | "${{ runner.os }}-pip-" 36 | - name: "Temporarily save coverage statistics" 37 | id: "temporarily-save-coverage-statistics" 38 | uses: "actions/cache@v2" 39 | with: 40 | path: ".coverage" 41 | key: ".coverage-${{ github.run_id }}-${{ github.run_number }}" 42 | - name: "Install requirements" 43 | id: "install-requirements" 44 | run: "make install" 45 | - name: "Run tests" 46 | id: "run-tests" 47 | env: 48 | PLATFORM: "${{ matrix.platform }}" 49 | run: "make tox" 50 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .gitignore 3 | 4 | 5 | # Autogenerated 6 | .*.swp 7 | *.pyc 8 | *.log 9 | *.pot 10 | *.pyo 11 | *.pyd 12 | *.pyx 13 | *.pyi 14 | __pycache__/* 15 | *~ 16 | *.orig 17 | *.bak 18 | .DS_Store 19 | *.save 20 | .mypy_cache/* 21 | .pytest_cache/* 22 | 23 | # IDE's 24 | .idea/* 25 | *sublime* 26 | *geany* 27 | *komodo* 28 | .vscode/* 29 | .project 30 | .pydevproject 31 | .settings/* 32 | 33 | 34 | # Project 35 | build/* 36 | dist/* 37 | *.egg-info/* 38 | .tox/* 39 | tmp/* 40 | log/* 41 | parts 42 | media/* 43 | *env*/ 44 | static/* 45 | *.pid 46 | .credentials 47 | .env 48 | .coverage 49 | htmlcov 50 | .direnv 51 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # .pre-commit-config.yaml 3 | 4 | 5 | repos: 6 | - repo: "local" 7 | hooks: 8 | - id: "seed-isort-config" 9 | name: "seed-isort-config" 10 | stages: ["commit"] 11 | language: "system" 12 | pass_filenames: false 13 | entry: "seed-isort-config" 14 | types: ["python"] 15 | - id: "removestar" 16 | name: "removestar" 17 | stages: ["commit"] 18 | language: "system" 19 | entry: "removestar -i \"${NAME}\" tests" 20 | types: ["python"] 21 | - id: "isort" 22 | name: "isort" 23 | stages: ["commit"] 24 | language: "system" 25 | entry: "isort" 26 | types: ["python"] 27 | - id: "black" 28 | name: "black" 29 | stages: ["commit"] 30 | language: "system" 31 | entry: "bash -c 'black \"${NAME}\"'" 32 | types: ["python"] 33 | - id: "yesqa" 34 | name: "yesqa" 35 | stages: ["commit"] 36 | language: "system" 37 | pass_filenames: false 38 | entry: "yesqa" 39 | types: ["python"] 40 | - id: "flake8" 41 | name: "flake8" 42 | stages: ["commit"] 43 | language: "system" 44 | entry: "flake8" 45 | types: ["python"] 46 | - id: "interrogate" 47 | name: "interrogate" 48 | stages: ["commit"] 49 | language: "system" 50 | entry: "bash -c 'interrogate \"${NAME}\" -I -M'" 51 | types: ["python"] 52 | - id: "pylint" 53 | name: "pylint" 54 | stages: ["commit"] 55 | language: "system" 56 | entry: "pylint \"${NAME}\" tests" 57 | types: ["python"] 58 | - id: "bandit" 59 | name: "bandit" 60 | stages: ["commit"] 61 | language: "system" 62 | entry: "bandit -r \"${NAME}\" tests --ini=setup.cfg" 63 | types: ["python"] 64 | pass_filenames: false 65 | - id: "dodgy" 66 | name: "dodgy" 67 | stages: ["commit"] 68 | language: "system" 69 | entry: "dodgy" 70 | types: ["python"] 71 | pass_filenames: false 72 | - id: "darglint" 73 | name: "darglint" 74 | stages: ["commit"] 75 | language: "system" 76 | entry: "darglint" 77 | types: ["python"] 78 | - id: "polint" 79 | name: "polint" 80 | stages: ["commit"] 81 | language: "system" 82 | entry: "polint --ignore=location,unsorted --show-msg" 83 | types: ["pofile"] 84 | pass_filenames: true 85 | - id: "dennis" 86 | name: "dennis" 87 | stages: ["commit"] 88 | language: "system" 89 | entry: "dennis-cmd lint" 90 | types: ["pofile"] 91 | pass_filenames: true 92 | - id: "curlylint" 93 | name: "curlylint" 94 | stages: ["commit"] 95 | language: "system" 96 | entry: "curlylint" 97 | types: ["html", "xml"] 98 | pass_filenames: true 99 | - id: "mypy" 100 | name: "mypy" 101 | stages: ["commit"] 102 | language: "system" 103 | entry: "bash -c 'PYTHONPATH=\"${PYTHONPATH}:${PWD}\" mypy'" 104 | types: ["python"] 105 | pass_filenames: false 106 | - id: "check-manifest" 107 | name: "check-manifest" 108 | stages: ["commit"] 109 | language: "system" 110 | pass_filenames: false 111 | entry: "check-manifest" 112 | - id: "pyroma" 113 | name: "pyroma" 114 | stages: ["commit"] 115 | language: "system" 116 | pass_filenames: false 117 | entry: "pyroma -d ." 118 | types: ["python"] 119 | - id: "check-wheel-contents" 120 | name: "check-wheel-contents" 121 | stages: ["commit"] 122 | language: "system" 123 | pass_filenames: false 124 | entry: "bash -c 'make build -B && check-wheel-contents dist'" 125 | types: ["python"] 126 | - id: "dotenv-linter" 127 | name: "dotenv-linter" 128 | entry: "dotenv-linter" 129 | language: "system" 130 | stages: ["commit"] 131 | types: ["text"] 132 | files: '\.env*' 133 | exclude: ".envrc" 134 | - repo: "https://github.com/pre-commit/pre-commit-hooks" 135 | rev: "v4.1.0" 136 | hooks: 137 | - id: "check-added-large-files" 138 | - id: "check-ast" 139 | - id: "check-case-conflict" 140 | - id: "check-docstring-first" 141 | - id: "check-executables-have-shebangs" 142 | - id: "check-merge-conflict" 143 | - id: "check-symlinks" 144 | - id: "check-yaml" 145 | - id: "debug-statements" 146 | - id: "detect-private-key" 147 | - id: "end-of-file-fixer" 148 | - id: "forbid-new-submodules" 149 | - id: "trailing-whitespace" 150 | -------------------------------------------------------------------------------- /.python-version: -------------------------------------------------------------------------------- 1 | 3.10.2 2 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # AUTHORS 3 | 4 | 5 | Authors ordered by first contribution. 6 | 7 | Johann Schmitz 8 | Giacomo Lacava 9 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # MANIFEST.in 3 | 4 | 5 | prune tests* 6 | recursive-include opensearch *.po 7 | recursive-include opensearch *.mo 8 | include opensearch/templates/opensearch/opensearch.xml 9 | include opensearch/templates/opensearch/templatetags/opensearch_meta.html 10 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # Makefile 3 | 4 | 5 | .ONESHELL: 6 | PHONY: install tox test makemessages compilemessages bumpversion build sign check check-build check-upload upload clean coveralls release help 7 | TEST_PYPI_URL ?= https://test.pypi.org/legacy/ 8 | NAME ?= opensearch 9 | EXTENSIONS ?= py,html,txt,xml 10 | TRASH_DIRS ?= build dist *.egg-info .tox .mypy_cache .pytest_cache __pycache__ htmlcov 11 | TRASH_FILES ?= .coverage 12 | BUILD_TYPES ?= bdist_wheel sdist 13 | VERSION ?= `python -c "import configparser; config = configparser.ConfigParser(); config.read('setup.cfg'); print(config['metadata']['version']);"` 14 | 15 | 16 | install: 17 | pip install .[test];\ 18 | 19 | 20 | tox: 21 | tox;\ 22 | 23 | 24 | test: 25 | bash -c 'PYTHONPATH="$${PYTHONPATH}:$${PWD}" py.test --cov=$(NAME) --modules-durations=0 --functions-durations=0 --instafail $(TESTS)';\ 26 | 27 | 28 | makemessages: 29 | for locale in `ls $(NAME)/locale`; do\ 30 | django-admin makemessages --locale=$${locale} --extension=$(EXTENSIONS);\ 31 | done;\ 32 | 33 | 34 | compilemessages: 35 | django-admin compilemessages;\ 36 | 37 | 38 | bumpversion: 39 | git tag -a $(VERSION) -m "v$(VERSION)";\ 40 | 41 | 42 | build: 43 | python setup.py $(BUILD_TYPES);\ 44 | 45 | 46 | sign: 47 | for package in `ls dist`; do\ 48 | gpg -a --detach-sign dist/$${package};\ 49 | done;\ 50 | 51 | 52 | check: 53 | bash -c 'NAME="$(NAME)" pre-commit run --all-files';\ 54 | 55 | 56 | check-build: 57 | twine check dist/*;\ 58 | 59 | 60 | check-upload: 61 | twine upload --skip-existing -s --repository-url $(TEST_PYPI_URL) -u __token__ -p $${TEST_TWINE_PASSWORD} dist/*;\ 62 | 63 | 64 | upload: 65 | twine upload --skip-existing -s dist/*;\ 66 | 67 | 68 | clean: 69 | for file in $(TRASH_FILES); do\ 70 | find -iname $${file} -print0 | xargs -0 rm -rf;\ 71 | done;\ 72 | for dir in $(TRASH_DIRS); do\ 73 | find -type d -name $${dir} ! -path "*/.direnv/*" -print0 | xargs -0 rm -rf;\ 74 | done;\ 75 | 76 | 77 | coveralls: 78 | coveralls;\ 79 | 80 | 81 | release: 82 | make clean && \ 83 | make bumpversion && \ 84 | git co master && \ 85 | git merge dev && \ 86 | git co dev && \ 87 | git push --all && \ 88 | git push --tags && \ 89 | make build && \ 90 | make sign && \ 91 | make check-build && \ 92 | make check-upload && \ 93 | make upload && \ 94 | make clean;\ 95 | 96 | 97 | help: 98 | @echo " help:" 99 | @echo " Show this help." 100 | @echo " install:" 101 | @echo " Install requirements." 102 | @echo " tox:" 103 | @echo " Run tox." 104 | @echo " test:" 105 | @echo " Run tests, can specify tests with 'TESTS' variable." 106 | @echo " makemessages:" 107 | @echo " Harvest translations." 108 | @echo " compilemessages:" 109 | @echo " Compile translations." 110 | @echo " bumpversion:" 111 | @echo " Tag current code revision with version." 112 | @echo " build:" 113 | @echo " Build python packages, can specify packages types with 'BUILD_TYPES' variable." 114 | @echo " sign:" 115 | @echo " Sign python packages." 116 | @echo " check:" 117 | @echo " Perform some code checks." 118 | @echo " check-build:" 119 | @echo " Run twine checks." 120 | @echo " check-upload:" 121 | @echo " Upload package to test PyPi using twine." 122 | @echo " upload:" 123 | @echo " Upload package to PyPi using twine." 124 | @echo " clean:" 125 | @echo " Recursively delete useless autogenerated files and directories, directories and files lists can be overriden through 'TRASH_DIRS' and 'TRASH_FILES' variables." 126 | @echo " coveralls:" 127 | @echo " Upload coverage report to Coveralls." 128 | @echo " release:" 129 | @echo " Release code." 130 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. django-opensearch 2 | .. README.rst 3 | 4 | 5 | A django-opensearch documentation 6 | ================================= 7 | 8 | |GitHub|_ |Coveralls|_ |pypi-license|_ |pypi-version|_ |pypi-python-version|_ |pypi-django-version|_ |pypi-format|_ |pypi-wheel|_ |pypi-status|_ 9 | 10 | *django-opensearch is a Django reusable application to handle opensearch.xml* 11 | 12 | .. contents:: 13 | 14 | Installation 15 | ------------ 16 | * 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/. 17 | * Run ``$ python ./setup.py install`` from the repository source tree or unpacked archive. Or use pip: ``$ pip install django-opensearch``. 18 | 19 | Configuration 20 | ------------- 21 | * Add ``"opensearch"`` to ``settings.INSTALLED_APPS``. 22 | 23 | .. code-block:: python 24 | 25 | # settings.py 26 | 27 | INSTALLED_APPS += [ 28 | "opensearch", 29 | ] 30 | 31 | * Add ``"opensearch"`` to your URLs definitions. 32 | 33 | .. code-block:: python 34 | 35 | # urls.py 36 | 37 | from django.urls import re_path 38 | 39 | 40 | urlpatterns += [ 41 | re_path(r"^opensearch/", include("opensearch.urls")), 42 | ] 43 | 44 | Usage 45 | ----- 46 | Load ``"opensearch_tags"`` to your base template and place opensearch rel meta tag to HTML tag by calling ``{% opensearch_meta %}``. 47 | 48 | .. code-block:: django 49 | 50 | {# base.html #} 51 | 52 | {% load opensearch_tags %} 53 | 54 | 55 | {% opensearch_meta %} 56 | 57 | 58 | Settings 59 | -------- 60 | ``OPENSEARCH_CONTACT_EMAIL`` 61 | Contains an email address at which the maintainer of the description document can be reached. Defaults to ``""``. 62 | 63 | ``OPENSEARCH_SHORT_NAME`` 64 | Contains a brief human-readable title that identifies this search engine. Defaults to ``""``. 65 | 66 | ``OPENSEARCH_DESCRIPTION`` 67 | Contains a human-readable text description of the search engine. Defaults to ``""``. 68 | 69 | ``OPENSEARCH_FAVICON_WIDTH`` 70 | Contains width of an image that can be used in association with this search content. Defaults to ``16``. 71 | 72 | ``OPENSEARCH_FAVICON_HEIGHT`` 73 | Contains height of an image that can be used in association with this search content. Defaults to ``16``. 74 | 75 | ``OPENSEARCH_FAVICON_TYPE`` 76 | Contains mimetype of an image that can be used in association with this search content. Defaults to ``"image/x-icon"``. 77 | 78 | ``OPENSEARCH_FAVICON_FILE`` 79 | Contains a URL that identifies the location of an image that can be used in association with this search content. Defaults to ``"favicon.ico"``. 80 | 81 | ``OPENSEARCH_SEARCH_URL`` 82 | Contains a Django URL name to search content. Defaults to ``"search"``. 83 | 84 | ``OPENSEARCH_SEARCH_QUERYSTRING`` 85 | Contains the querystring to prepend to search parameter. Defaults to ``"q="``. 86 | 87 | ``OPENSEARCH_INPUT_ENCODING`` 88 | Contains a string that indicates that the search engine supports search requests encoded with the specified character encoding. Defaults to ``"UTF-8"``. 89 | 90 | Contributing 91 | ------------ 92 | 1. `Fork it `_ 93 | 2. Install `GNU Make `_ 94 | 3. Install and configure `pyenv `_ and `pyenv-virtualenv plugin `_ 95 | 4. Install and configure `direnv `_ 96 | 5. Create environment config from example 97 | 98 | .. code-block:: bash 99 | 100 | cp .env.example .env 101 | 102 | 6. Install development dependencies: 103 | 104 | .. code-block:: bash 105 | 106 | make install 107 | 108 | 7. Create your fix/feature branch: 109 | 110 | .. code-block:: bash 111 | 112 | git checkout -b my-new-fix-or-feature 113 | 114 | 8. Check code style and moreover: 115 | 116 | .. code-block:: bash 117 | 118 | make check 119 | 120 | 9. Run tests: 121 | 122 | .. code-block:: bash 123 | 124 | make test 125 | 126 | 10. Push to the branch: 127 | 128 | .. code-block:: bash 129 | 130 | git push origin my-new-fix-or-feature 131 | 132 | 11. `Create a new Pull Request `_ 133 | 134 | Licensing 135 | --------- 136 | 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. 137 | For complete license text see COPYING file. 138 | 139 | Contacts 140 | -------- 141 | **Project Website**: https://github.com/vint21h/django-opensearch/ 142 | 143 | **Author**: Alexei Andrushievich 144 | 145 | For other authors list see AUTHORS file. 146 | 147 | .. |GitHub| image:: https://github.com/vint21h/django-opensearch/workflows/build/badge.svg 148 | :alt: GitHub 149 | .. |Coveralls| image:: https://coveralls.io/repos/github/vint21h/django-opensearch/badge.svg?branch=master 150 | :alt: Coverage 151 | .. |pypi-license| image:: https://img.shields.io/pypi/l/django-opensearch 152 | :alt: License 153 | .. |pypi-version| image:: https://img.shields.io/pypi/v/django-opensearch 154 | :alt: Version 155 | .. |pypi-django-version| image:: https://img.shields.io/pypi/djversions/django-opensearch 156 | :alt: Supported Django version 157 | .. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/django-opensearch 158 | :alt: Supported Python version 159 | .. |pypi-format| image:: https://img.shields.io/pypi/format/django-opensearch 160 | :alt: Package format 161 | .. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/django-opensearch 162 | :alt: Python wheel support 163 | .. |pypi-status| image:: https://img.shields.io/pypi/status/django-opensearch 164 | :alt: Package status 165 | .. _GitHub: https://github.com/vint21h/django-opensearch/actions/ 166 | .. _Coveralls: https://coveralls.io/github/vint21h/django-opensearch?branch=master 167 | .. _pypi-license: https://pypi.org/project/django-opensearch/ 168 | .. _pypi-version: https://pypi.org/project/django-opensearch/ 169 | .. _pypi-django-version: https://pypi.org/project/django-opensearch/ 170 | .. _pypi-python-version: https://pypi.org/project/django-opensearch/ 171 | .. _pypi-format: https://pypi.org/project/django-opensearch/ 172 | .. _pypi-wheel: https://pypi.org/project/django-opensearch/ 173 | .. _pypi-status: https://pypi.org/project/django-opensearch/ 174 | -------------------------------------------------------------------------------- /opensearch/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/__init__.py 5 | 6 | 7 | from typing import List 8 | 9 | 10 | __all__: List[str] = ["default_app_config"] 11 | 12 | 13 | default_app_config: str = "opensearch.apps.DjangoOpensearchConfig" 14 | -------------------------------------------------------------------------------- /opensearch/apps.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/apps.py 5 | 6 | 7 | from typing import List 8 | 9 | from django.apps import AppConfig 10 | from django.utils.translation import gettext_lazy as _ 11 | 12 | 13 | __all__: List[str] = ["DjangoOpensearchConfig"] 14 | 15 | 16 | class DjangoOpensearchConfig(AppConfig): 17 | """Django opensearch.xml config.""" 18 | 19 | name: str = "opensearch" 20 | verbose_name: str = _("Django opensearch.xml") 21 | -------------------------------------------------------------------------------- /opensearch/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/conf.py 5 | 6 | 7 | from typing import List 8 | 9 | from appconf import AppConf 10 | from django.conf import settings 11 | 12 | 13 | __all__: List[str] = ["settings"] 14 | 15 | 16 | class DjangoOpensearchAppConf(AppConf): 17 | """Django opensearch.xml settings.""" 18 | 19 | CONTACT_EMAIL: str = getattr(settings, "OPENSEARCH_CONTACT_EMAIL", "") 20 | SHORT_NAME: str = getattr(settings, "OPENSEARCH_SHORT_NAME", "") 21 | DESCRIPTION: str = getattr(settings, "OPENSEARCH_DESCRIPTION", "") 22 | FAVICON_WIDTH: int = getattr(settings, "OPENSEARCH_FAVICON_WIDTH", 16) 23 | FAVICON_HEIGHT: int = getattr(settings, "OPENSEARCH_FAVICON_HEIGHT", 16) 24 | FAVICON_TYPE: str = getattr(settings, "OPENSEARCH_FAVICON_TYPE", "image/x-icon") 25 | FAVICON_FILE: str = getattr(settings, "OPENSEARCH_FAVICON_FILE", "favicon.ico") 26 | SEARCH_URL: str = getattr(settings, "OPENSEARCH_SEARCH_URL", "search") 27 | SEARCH_QUERYSTRING: str = getattr(settings, "OPENSEARCH_SEARCH_QUERYSTRING", "q=") 28 | INPUT_ENCODING: str = getattr(settings, "OPENSEARCH_INPUT_ENCODING", "UTF-8") 29 | 30 | class Meta: 31 | """Config settings.""" 32 | 33 | prefix: str = "opensearch" 34 | -------------------------------------------------------------------------------- /opensearch/locale/en/LC_MESSAGES/django.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vint21h/django-opensearch/51b232e1dba73c7b0c8f86f0ee674fe52c1c290e/opensearch/locale/en/LC_MESSAGES/django.mo -------------------------------------------------------------------------------- /opensearch/locale/en/LC_MESSAGES/django.po: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # opensearch/locale/en/LC_MESSAGES/django.po 3 | # 4 | #, fuzzy 5 | msgid "" 6 | msgstr "" 7 | "Project-Id-Version: django-opensearch 0.20.0\n" 8 | "Report-Msgid-Bugs-To: Alexei Andrushievich \n" 9 | "POT-Creation-Date: 2022-02-20 00:41+0200\n" 10 | "PO-Revision-Date: 2019-08-25 22:42+0300\n" 11 | "Last-Translator: Alexei Andrushievich \n" 12 | "Language-Team: Alexei Andrushievich \n" 13 | "Language: en\n" 14 | "MIME-Version: 1.0\n" 15 | "Content-Type: text/plain; charset=UTF-8\n" 16 | "Content-Transfer-Encoding: 8bit\n" 17 | 18 | #: opensearch/apps.py:20 19 | msgid "Django opensearch.xml" 20 | msgstr "Django opensearch.xml" 21 | -------------------------------------------------------------------------------- /opensearch/locale/uk/LC_MESSAGES/django.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vint21h/django-opensearch/51b232e1dba73c7b0c8f86f0ee674fe52c1c290e/opensearch/locale/uk/LC_MESSAGES/django.mo -------------------------------------------------------------------------------- /opensearch/locale/uk/LC_MESSAGES/django.po: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # opensearch/locale/uk/LC_MESSAGES/django.po 3 | # 4 | #, fuzzy 5 | msgid "" 6 | msgstr "" 7 | "Project-Id-Version: django-opensearch 0.20.0\n" 8 | "Report-Msgid-Bugs-To: Alexei Andrushievich \n" 9 | "POT-Creation-Date: 2022-02-20 00:41+0200\n" 10 | "PO-Revision-Date: 2019-08-25 22:42+0300\n" 11 | "Last-Translator: Alexei Andrushievich \n" 12 | "Language-Team: Alexei Andrushievich \n" 13 | "Language: uk\n" 14 | "MIME-Version: 1.0\n" 15 | "Content-Type: text/plain; charset=UTF-8\n" 16 | "Content-Transfer-Encoding: 8bit\n" 17 | "Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n" 18 | "%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n" 19 | 20 | #: opensearch/apps.py:20 21 | msgid "Django opensearch.xml" 22 | msgstr "Django opensearch.xml" 23 | -------------------------------------------------------------------------------- /opensearch/templates/opensearch/opensearch.xml: -------------------------------------------------------------------------------- 1 | {% load i18n %}{% load static %} 2 | 3 | {% block contact %}{% if OPENSEARCH_CONTACT_EMAIL %}{{ OPENSEARCH_CONTACT_EMAIL }}{% endif %}{% endblock %} 4 | {% block short-name %}{% if OPENSEARCH_SHORT_NAME %}{% trans OPENSEARCH_SHORT_NAME %}{% endif %}{% endblock %} 5 | {% block description %}{% if OPENSEARCH_DESCRIPTION %}{% trans OPENSEARCH_DESCRIPTION %}{% endif %}{% endblock %} 6 | {% block image %}{% if OPENSEARCH_FAVICON_WIDTH and OPENSEARCH_FAVICON_HEIGHT and OPENSEARCH_FAVICON_TYPE and OPENSEARCH_FAVICON_FILE %}{% static OPENSEARCH_FAVICON_FILE %}{% endif %}{% endblock %} 7 | {% block url %}{% if OPENSEARCH_URL %}{% endif %}{% endblock %} 8 | {% block input-encoding %}{% if OPENSEARCH_INPUT_ENCODING %}{{ OPENSEARCH_INPUT_ENCODING }}{% endif %}{% endblock %} 9 | 10 | -------------------------------------------------------------------------------- /opensearch/templates/opensearch/templatetags/opensearch_meta.html: -------------------------------------------------------------------------------- 1 | {# django-opensearch #} 2 | {# opensearch/templates/opensearch/templatetags/opensearch_meta.html #} 3 | 4 | 5 | {% load i18n %} 6 | 7 | 8 | {% block search %} 9 | {% if OPENSEARCH_DESCRIPTION %} 10 | 11 | {% endif %} 12 | {% endblock %} 13 | -------------------------------------------------------------------------------- /opensearch/templatetags/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/templatetags/__init__.py 5 | 6 | 7 | from typing import List 8 | 9 | 10 | __all__: List[str] = [] 11 | -------------------------------------------------------------------------------- /opensearch/templatetags/opensearch_tags.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/templatetags/opensearch_tags.py 5 | 6 | 7 | from typing import Dict, List 8 | 9 | from django import template 10 | 11 | from opensearch.conf import settings 12 | 13 | 14 | __all__: List[str] = ["opensearch_meta"] 15 | 16 | 17 | register = template.Library() 18 | 19 | 20 | @register.inclusion_tag("opensearch/templatetags/opensearch_meta.html") 21 | def opensearch_meta() -> Dict[str, str]: 22 | """ 23 | Return meta rel opensearch tag. 24 | 25 | :return: opensearch description 26 | :rtype: Dict[str, str] 27 | """ 28 | return {"OPENSEARCH_DESCRIPTION": settings.OPENSEARCH_DESCRIPTION} 29 | -------------------------------------------------------------------------------- /opensearch/urls.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/urls.py 5 | 6 | 7 | from typing import List, Union 8 | 9 | from django.urls import re_path 10 | from django.urls.resolvers import URLPattern, URLResolver 11 | 12 | from opensearch.views import opensearch 13 | 14 | 15 | __all__: List[str] = ["urlpatterns"] 16 | 17 | 18 | # opensearch urls 19 | urlpatterns: List[Union[URLPattern, URLResolver]] = [ 20 | re_path(r"^opensearch\.xml$", opensearch, name="opensearch") # opensearch 21 | ] 22 | -------------------------------------------------------------------------------- /opensearch/views.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # opensearch/views.py 5 | 6 | 7 | from typing import Dict, List, Union 8 | 9 | from django.http import HttpResponse 10 | from django.http.request import HttpRequest 11 | from django.shortcuts import render, resolve_url 12 | 13 | from opensearch.conf import settings 14 | 15 | 16 | __all__: List[str] = ["opensearch"] 17 | 18 | 19 | def opensearch(request: HttpRequest) -> HttpResponse: 20 | """ 21 | Render opensearch.xml. 22 | 23 | :param request: django request instance 24 | :type request: HttpRequest 25 | :return: rendered opensearch.xml 26 | :rtype: HttpResponse 27 | """ 28 | context: Dict[str, Union[str, int]] = { 29 | "OPENSEARCH_CONTACT_EMAIL": settings.OPENSEARCH_CONTACT_EMAIL, 30 | "OPENSEARCH_SHORT_NAME": settings.OPENSEARCH_SHORT_NAME, 31 | "OPENSEARCH_DESCRIPTION": settings.OPENSEARCH_DESCRIPTION, 32 | "OPENSEARCH_FAVICON_WIDTH": settings.OPENSEARCH_FAVICON_WIDTH, 33 | "OPENSEARCH_FAVICON_HEIGHT": settings.OPENSEARCH_FAVICON_HEIGHT, 34 | "OPENSEARCH_FAVICON_TYPE": settings.OPENSEARCH_FAVICON_TYPE, 35 | "OPENSEARCH_FAVICON_FILE": settings.OPENSEARCH_FAVICON_FILE, 36 | "OPENSEARCH_URL": "{url}?{querystring}{{searchTerms}}".format( # noqa: FS002 37 | **{ 38 | "url": request.build_absolute_uri( 39 | resolve_url(to=settings.OPENSEARCH_SEARCH_URL) 40 | ), 41 | "querystring": settings.OPENSEARCH_SEARCH_QUERYSTRING, 42 | } 43 | ), 44 | "OPENSEARCH_INPUT_ENCODING": settings.OPENSEARCH_INPUT_ENCODING.upper(), 45 | } 46 | 47 | return render( 48 | request=request, 49 | template_name="opensearch/opensearch.xml", 50 | context=context, 51 | content_type="application/opensearchdescription+xml", 52 | ) 53 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # django-opensearch 2 | # setup.cfg 3 | 4 | 5 | [metadata] 6 | name = django-opensearch 7 | version = 0.20.0 8 | description = Handle opensearch.xml 9 | python_requires = >=3.7 10 | license_file = COPYING 11 | author = Alexei Andrushievich 12 | author_email = vint21h@vint21h.pp.ua 13 | url = https://github.com/vint21h/django-opensearch/ 14 | classifiers = 15 | Development Status :: 5 - Production/Stable 16 | Environment :: Plugins 17 | Framework :: Django :: 2.2 18 | Framework :: Django :: 3.2 19 | Framework :: Django :: 4.0 20 | License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) 21 | Operating System :: Unix 22 | Programming Language :: Python :: 3.7 23 | Programming Language :: Python :: 3.8 24 | Programming Language :: Python :: 3.9 25 | Programming Language :: Python :: 3.10 26 | Topic :: Utilities 27 | license = GPLv3+ 28 | long_description = file:README.rst 29 | long_description_content_type = text/x-rst 30 | keywords = django,opensearch,opensearch.xml 31 | 32 | [options] 33 | packages = find: 34 | zip_safe = False 35 | include_package_data = True 36 | test_suite = tests 37 | install_requires = 38 | django>=2.2,<4.1 39 | django-appconf>=1.0.3 40 | 41 | [options.extras_require] 42 | test = 43 | attrs==21.4.0 44 | bandit==1.7.2 45 | black==22.1.0 46 | bpython==0.22.1 47 | check-manifest==0.47 48 | check-wheel-contents==0.3.4 49 | coverage==6.3.1 50 | coveralls==3.3.1 51 | curlylint==0.13.0 52 | darglint==1.8.1 53 | dennis==0.9 54 | django-stubs==1.9.0 55 | dlint==0.12.0 56 | dodgy==0.2.1 57 | dotenv-linter==0.3.0 58 | flake8-annotations-complexity==0.0.6 59 | flake8-annotations-coverage==0.0.5 60 | flake8-broken-line==0.4.0 61 | flake8-bugbear==22.1.11 62 | flake8-builtins==1.5.3 63 | flake8-coding==1.3.2 64 | flake8-cognitive-complexity==0.1.0 65 | flake8-comprehensions==3.8.0 66 | flake8-debugger==4.0.0 67 | flake8-django==1.1.2 68 | flake8-docstrings==1.6.0 69 | flake8-eradicate==1.2.0 70 | flake8-executable==2.1.1 71 | flake8-expression-complexity==0.0.9 72 | flake8-fixme==1.1.1 73 | flake8-functions==0.0.6 74 | flake8-mutable==1.2.0 75 | flake8-no-implicit-concat==0.3.3 76 | flake8-print==4.0.0 77 | flake8-return==1.1.3 78 | flake8-simplify==0.17.1 79 | flake8-typing-imports==1.12.0 80 | flake8-use-fstring==1.3 81 | flake8-variables-names==0.0.4 82 | flake8==3.9.2 # do not update before ALL plugins start 4.x support 83 | importlib-metadata==4.11.1 84 | interrogate==1.5.0 85 | isort==5.10.1 86 | mypy==0.931 87 | pep8-naming==0.12.1 88 | pip-outdated==0.5.0 89 | polint==0.4 90 | pre-commit-hooks==4.1.0 91 | pre-commit==2.17.0 92 | pygments==2.11.2 93 | pylint-django==2.5.2 94 | pylint==2.12.2 95 | pyroma==3.2 96 | pytest-cov==3.0.0 97 | pytest-django==4.5.2 98 | pytest-extra-durations==0.1.3 99 | pytest-instafail==0.4.2 100 | pytest-sugar==0.9.4 101 | pytest-timer[termcolor]==0.0.11 102 | pytest==7.0.1 103 | readme_renderer==32.0 104 | removestar==1.3.1 105 | seed-isort-config==2.2.0 106 | tabulate==0.8.9 107 | tox-gh-actions==2.9.1 108 | tox-pyenv==1.1.0 109 | tox==3.24.5 110 | twine==3.8.0 111 | wheel==0.37.1 112 | yesqa==1.3.0 113 | 114 | 115 | [options.packages.find] 116 | exclude = 117 | tests.* 118 | tests 119 | 120 | [bdist_wheel] 121 | universal = False 122 | 123 | [sdist] 124 | formats = zip 125 | 126 | 127 | [mypy] 128 | files = opensearch,tests 129 | check_untyped_defs = True 130 | disallow_any_generics = True 131 | disallow_untyped_calls = True 132 | ignore_errors = False 133 | ignore_missing_imports = True 134 | implicit_reexport = True 135 | strict_optional = True 136 | strict_equality = True 137 | no_implicit_optional = True 138 | warn_unused_ignores = True 139 | warn_redundant_casts = True 140 | warn_unused_configs = True 141 | warn_unreachable = True 142 | warn_no_return = True 143 | plugins = mypy_django_plugin.main 144 | 145 | [mypy.plugins.django-stubs] 146 | django_settings_module = tests.settings 147 | 148 | 149 | [flake8] 150 | max-line-length = 88 151 | select = B,C,D,E,F,W,T4,C4,TAE,T,M511,T100,TYP,A,EXE,CFQ,SIM,DUO,N,DJ,ECE,FS,R,CCR,NIC 152 | doctests = True 153 | ignore = D100,D104,D401 154 | max-annotations-complexity = 5 155 | max-expression-complexity = 5 156 | max-cognitive-complexity = 5 157 | min-python-version = 3.7 158 | exclude = setup.py 159 | 160 | 161 | [check-manifest] 162 | ignore = 163 | .editorconfig 164 | .env 165 | .env.example 166 | .envrc 167 | .gitattributes 168 | .github 169 | .gitignore 170 | .pre-commit-config.yaml 171 | .python-version 172 | AUTHORS 173 | COPYING 174 | Makefile 175 | README.rst 176 | tests 177 | tests.* 178 | TODO 179 | ignore-bad-ideas = 180 | *.mo 181 | 182 | 183 | [coverage:run] 184 | branch = True 185 | source = opensearch 186 | omit = 187 | */__init__.py 188 | opensearch/apps.py 189 | 190 | [coverage:report] 191 | omit = 192 | */__init__.py 193 | opensearch/apps.py 194 | exclude_lines = 195 | pragma: no cover 196 | 197 | 198 | [isort] 199 | balanced_wrapping = True 200 | combine_as_imports = True 201 | default_section = FIRSTPARTY 202 | force_grid_wrap = 0 203 | force_sort_within_sections = True 204 | force_to_top = True 205 | include_trailing_comma = True 206 | known_first_party = opensearch 207 | line_length = 88 208 | lines_after_imports = 2 209 | length_sort = True 210 | multi_line_output = 3 211 | use_parentheses = True 212 | virtual_env = $VIRTUAL_ENV 213 | known_third_party = appconf,django,setuptools 214 | 215 | 216 | [darglint] 217 | docstring_style = sphinx 218 | 219 | 220 | [bandit] 221 | skips = B507 222 | tests = B101,B102,B103,B104,B105,B106,B107,B108,B110,B112,B201,B301,B302,B303,B304,B305,B306,B307,B308,B309,B310,B311,B312,B313,B314,B315,B316,B317,B318,B319,B320,B321,B323,B324,B325,B401,B402,B403,B404,B405,B406,B407,B408,B409,B410,B411,B412,B413,B501,B502,B503,B504,B505,B506,B601,B602,B603,B604,B605,B606,B607,B608,B609,B610,B611,B701,B702,B703 223 | 224 | 225 | [tool:check-wheel-contents] 226 | ignore = W004 227 | 228 | 229 | [tox:tox] 230 | skip_missing_interpreters = True 231 | tox_pyenv_fallback = False 232 | skipsdist = False 233 | envlist = 234 | {py37,py38,py39,py310}-2.2.x 235 | {py37,py38,py39,py310}-3.2.x 236 | {py38,py39,py310}-4.0.x 237 | check 238 | check-build 239 | 240 | [testenv] 241 | usedevelop = True 242 | setenv = 243 | PYTHONDONTWRITEBYTECODE=1 244 | deps = 245 | 2.2.x: Django>=2.2,<3.0 246 | 3.2.x: Django>=3.2,<4.0 247 | 4.0.x: Django>=4.0,<4.1 248 | commands= 249 | pip install .[test] 250 | make test 251 | whitelist_externals = 252 | make 253 | 254 | [testenv:check] 255 | skip_install = True 256 | commands = 257 | make check 258 | whitelist_externals = 259 | make 260 | 261 | [testenv:check-build] 262 | skip_install = True 263 | commands = 264 | make build -B 265 | make check-build -B 266 | whitelist_externals = 267 | make 268 | 269 | 270 | [gh-actions] 271 | python = 272 | 3.6: py36 273 | 3.7: py37 274 | 3.8: py38 275 | 3.9: py39 276 | 3.10: py310 277 | 278 | 279 | [pylint.MASTER] 280 | ignore = CVS 281 | ignore-patterns = 282 | persistent = yes 283 | load-plugins = pylint_django 284 | jobs = 1 285 | unsafe-load-any-extension = no 286 | extension-pkg-whitelist = 287 | optimize-ast = no 288 | 289 | [pylint.'MESSAGES CONTROL'] 290 | confidence = 291 | disable = all 292 | enable = E0001,E0100,E0101,E0102,E0103,E0104,E0105,E0106,E0107,E0110, 293 | E0113,E0114,E0115,E0116,E0117,E0108,E0202,E0203,E0211,E0236, 294 | E0238,E0239,E0240,E0241,E0301,E0302,E0601,E0603,E0604,E0701, 295 | E0702,E0703,E0704,E0710,E0711,E0712,E1003,E1102,E1111,E0112, 296 | E1120,E1121,E1123,E1124,E1125,E1126,E1127,E1132,E1200,E1201, 297 | E1205,E1206,E1300,E1301,E1302,E1303,E1304,E1305,E1306, 298 | C0123,C0200,C0303,C1001, 299 | W0101,W0102,W0104,W0105,W0106,W0107,W0108,W0109,W0110,W0120, 300 | W0122,W0124,W0150,W0199,W0221,W0222,W0233,W0404,W0410,W0601, 301 | W0602,W0604,W0611,W0612,W0622,W0623,W0702,W0705,W0711,W1300, 302 | W1301,W1302,W1303,,W1305,W1306,W1307 303 | R0102,R0201,R0202,R0203 304 | 305 | [pylint.REPORTS] 306 | output-format = text 307 | files-output = no 308 | reports = yes 309 | evaluation = 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) 310 | 311 | [pylint.BASIC] 312 | good-names = i,j,k,ex,Run,_ 313 | bad-names = foo,bar,baz,toto,tutu,tata 314 | name-group = 315 | include-naming-hint = no 316 | property-classes = abc.abstractproperty 317 | const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__))$ 318 | const-name-hint = (([A-Z_][A-Z0-9_]*)|(__.*__))$ 319 | class-rgx = [A-Z_][a-zA-Z0-9]+$ 320 | class-name-hint = [A-Z_][a-zA-Z0-9]+$ 321 | argument-rgx = [a-z_][a-z0-9_]{2,30}$ 322 | argument-name-hint = [a-z_][a-z0-9_]{2,30}$ 323 | variable-rgx = [a-z_][a-z0-9_]{2,30}$ 324 | variable-name-hint = [a-z_][a-z0-9_]{2,30}$ 325 | class-attribute-rgx = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 326 | class-attribute-name-hint = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 327 | method-rgx = [a-z_][a-z0-9_]{2,30}$ 328 | method-name-hint = [a-z_][a-z0-9_]{2,30}$ 329 | module-rgx = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 330 | module-name-hint = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 331 | function-rgx = [a-z_][a-z0-9_]{2,30}$ 332 | function-name-hint = [a-z_][a-z0-9_]{2,30}$ 333 | attr-rgx = [a-z_][a-z0-9_]{2,30}$ 334 | attr-name-hint = [a-z_][a-z0-9_]{2,30}$ 335 | inlinevar-rgx = [A-Za-z_][A-Za-z0-9_]*$ 336 | inlinevar-name-hint = [A-Za-z_][A-Za-z0-9_]*$ 337 | no-docstring-rgx = ^_ 338 | docstring-min-length = -1 339 | 340 | [pylint.ELIF] 341 | max-nested-blocks = 5 342 | 343 | [pylint.FORMAT] 344 | max-line-length = 88 345 | ignore-long-lines = ^\s*(# )??$ 346 | single-line-if-stmt = no 347 | no-space-check = trailing-comma,dict-separator 348 | max-module-lines = 1000 349 | indent-string=' ' 350 | indent-after-paren = 4 351 | expected-line-ending-format = LF 352 | 353 | [pylint.LOGGING] 354 | logging-modules = logging 355 | 356 | [pylint.MISCELLANEOUS] 357 | notes = FIXME,XXX,TODO 358 | 359 | [pylint.SIMILARITIES] 360 | min-similarity-lines = 4 361 | ignore-comments = yes 362 | ignore-docstrings = yes 363 | ignore-imports = no 364 | 365 | [pylint.SPELLING] 366 | spelling-dict = 367 | spelling-ignore-words = 368 | spelling-private-dict-file = 369 | spelling-store-unknown-words = no 370 | 371 | [pylint.TYPECHECK] 372 | ignore-mixin-members = yes 373 | ignored-modules = 374 | ignored-classes = optparse.Values,thread._local,_thread._local 375 | generated-members = 376 | contextmanager-decorators = contextlib.contextmanager 377 | 378 | [pylint.VARIABLES] 379 | init-import = no 380 | dummy-variables-rgx = (_+[a-zA-Z0-9]*?$)|dummy 381 | additional-builtins = 382 | callbacks = cb_,_cb 383 | redefining-builtins-modules = six.moves,future.builtins 384 | 385 | [pylint.CLASSES] 386 | defining-attr-methods = __init__,__new__,setUp 387 | valid-classmethod-first-arg = cls 388 | valid-metaclass-classmethod-first-arg = mcs 389 | exclude-protected = _asdict,_fields,_replace,_source,_make 390 | 391 | [pylint.DESIGN] 392 | max-args = 5 393 | ignored-argument-names = _.* 394 | max-locals = 15 395 | max-returns = 6 396 | max-branches = 12 397 | max-statements = 50 398 | max-parents = 7 399 | max-attributes = 7 400 | min-public-methods = 2 401 | max-public-methods = 20 402 | max-bool-expr = 5 403 | 404 | [pylint.IMPORTS] 405 | deprecated-modules = optparse 406 | import-graph = 407 | ext-import-graph = 408 | int-import-graph = 409 | known-standard-library = 410 | known-third-party = enchant 411 | analyse-fallback-blocks = no 412 | 413 | [pylint.EXCEPTIONS] 414 | overgeneral-exceptions = Exception 415 | 416 | 417 | [tool:pytest] 418 | DJANGO_SETTINGS_MODULE = tests.settings 419 | python_files = tests.py test_*.py *_tests.py 420 | python_classes = 421 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # -*- coding: utf-8 -*- 4 | 5 | # django-opensearch 6 | # setup.py 7 | 8 | 9 | import setuptools 10 | 11 | 12 | if __name__ == "__main__": 13 | setuptools.setup() 14 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # tests/__init__.py 5 | 6 | 7 | from typing import List 8 | 9 | 10 | __all__: List[str] = [] 11 | -------------------------------------------------------------------------------- /tests/settings.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # tests/settings.py 5 | 6 | 7 | import sys 8 | import pathlib 9 | from random import SystemRandom 10 | from typing import Dict, List, Union 11 | 12 | 13 | # black magic to use imports from library code 14 | path = pathlib.Path(__file__).absolute() 15 | project = path.parent.parent.parent 16 | sys.path.insert(0, str(project)) 17 | 18 | # secret key 19 | SECRET_KEY: str = "".join( 20 | [ 21 | SystemRandom().choice("abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)") 22 | for i in range(50) 23 | ] 24 | ) 25 | 26 | # security settings 27 | ALLOWED_HOSTS: List[str] = ["example.com"] 28 | 29 | # configure databases 30 | DATABASES: Dict[str, Dict[str, str]] = { 31 | "default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"} 32 | } 33 | 34 | # configure templates 35 | TEMPLATES: List[Dict[str, Union[str, List[str], bool, Dict[str, str]]]] = [ 36 | { 37 | "BACKEND": "django.template.backends.django.DjangoTemplates", 38 | "DIRS": [], 39 | "APP_DIRS": True, 40 | "OPTIONS": {}, 41 | } 42 | ] 43 | 44 | 45 | INSTALLED_APPS: List[str] = ["opensearch"] 46 | 47 | # configure urls 48 | ROOT_URLCONF: str = "opensearch.urls" 49 | 50 | # opensearch settings 51 | OPENSEARCH_CONTACT_EMAIL: str = "test@example.com" 52 | OPENSEARCH_SHORT_NAME: str = "opensearch" 53 | OPENSEARCH_DESCRIPTION: str = "Search engine human-readable text description" 54 | OPENSEARCH_FAVICON_WIDTH: int = 16 55 | OPENSEARCH_FAVICON_HEIGHT: int = 16 56 | OPENSEARCH_FAVICON_TYPE: str = "image/x-icon" 57 | OPENSEARCH_FAVICON_FILE: str = "favicon.ico" 58 | OPENSEARCH_SEARCH_URL: str = "search" 59 | OPENSEARCH_SEARCH_QUERYSTRING: str = "q=" 60 | OPENSEARCH_INPUT_ENCODING: str = "UTF-8" 61 | -------------------------------------------------------------------------------- /tests/templatetags/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # tests/templatetags/__init__.py 5 | 6 | 7 | from typing import List 8 | 9 | 10 | __all__: List[str] = [] 11 | -------------------------------------------------------------------------------- /tests/templatetags/test_opensearch_tags.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # tests/templatetags/test_opensearch_tags.py 5 | 6 | 7 | from typing import Dict, List 8 | 9 | from django.test import TestCase 10 | from django.template import Context, Template 11 | from django.test.utils import override_settings 12 | 13 | from opensearch.conf import settings 14 | from opensearch.templatetags.opensearch_tags import opensearch_meta 15 | 16 | 17 | __all__: List[str] = ["OpensearchMetaTemplatetagTest"] 18 | 19 | 20 | class OpensearchMetaTemplatetagTest(TestCase): 21 | """Opensearch meta templatetag tests.""" 22 | 23 | def test_opensearch_meta__return(self) -> None: 24 | """Test templatetag returning value.""" 25 | result: Dict[str, str] = opensearch_meta() 26 | expected: Dict[str, str] = { 27 | "OPENSEARCH_DESCRIPTION": settings.OPENSEARCH_DESCRIPTION 28 | } 29 | 30 | self.assertIsInstance(obj=result, cls=dict) 31 | self.assertDictEqual(d1=result, d2=expected) 32 | 33 | def test_opensearch_meta__render(self) -> None: 34 | """Test templatetag rendering result.""" 35 | template: Template = Template( 36 | """ 37 | {% load opensearch_tags %} 38 | {% opensearch_meta %} 39 | """ 40 | ) 41 | result: str = template.render(context=Context()) 42 | expected: str = '' # noqa: E501 43 | 44 | self.assertHTMLEqual(html1=result, html2=expected) 45 | 46 | @override_settings(OPENSEARCH_DESCRIPTION="") 47 | def test_opensearch_meta__render__without_description(self) -> None: 48 | """Test templatetag rendering result without description.""" 49 | template: Template = Template( 50 | """ 51 | {% load opensearch_tags %} 52 | {% opensearch_meta %} 53 | """ 54 | ) 55 | result: str = template.render(context=Context()) 56 | expected: str = "" 57 | 58 | self.assertHTMLEqual(html1=result, html2=expected) 59 | -------------------------------------------------------------------------------- /tests/test_views.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # django-opensearch 4 | # tests/test_views.py 5 | 6 | 7 | from typing import List, Union 8 | 9 | from django.test import TestCase 10 | from django.shortcuts import resolve_url 11 | from django.urls import include, re_path 12 | from django.test.utils import override_settings 13 | from django.http import HttpRequest, HttpResponse 14 | from django.urls.exceptions import NoReverseMatch 15 | from django.urls.resolvers import URLPattern, URLResolver 16 | from django.utils.translation import override as override_translation 17 | 18 | from opensearch.views import opensearch 19 | 20 | 21 | __all__: List[str] = ["OpensearchViewTest"] 22 | 23 | 24 | def search(request: HttpRequest) -> HttpResponse: 25 | """ 26 | Fake search view. 27 | 28 | :param request: django request instance 29 | :type request: HttpRequest 30 | :return: rendered opensearch.xml 31 | :rtype: HttpResponse 32 | """ 33 | return HttpResponse() 34 | 35 | 36 | urlpatterns: List[Union[URLPattern, URLResolver]] = [ 37 | re_path(r"^search$", search, name="search") # fake search view 38 | ] 39 | urlpatterns += [re_path(r"^opensearch/", include("opensearch.urls"))] 40 | 41 | 42 | @override_settings(ROOT_URLCONF="tests.test_views") 43 | class OpensearchViewTest(TestCase): 44 | """opensearch.xml view tests.""" 45 | 46 | def test_humans_txt__return_response(self) -> None: 47 | """Test view returning response.""" 48 | request: HttpRequest = HttpRequest() 49 | request.META.update({"SERVER_NAME": "example.com", "SERVER_PORT": 80}) 50 | 51 | self.assertIsInstance(obj=opensearch(request=request), cls=HttpResponse) 52 | 53 | @override_translation(language="en") 54 | def test_opensearch__render__template_used(self) -> None: 55 | """Test view right template usage.""" 56 | result: HttpResponse = self.client.get( 57 | path=resolve_url(to="opensearch") 58 | ) 59 | 60 | self.assertTemplateUsed( 61 | response=result, template_name="opensearch/opensearch.xml" 62 | ) 63 | 64 | @override_translation(language="en") 65 | def test_opensearch__render(self) -> None: 66 | """Test view rendering result.""" 67 | expected: str = """ 68 | 69 | test@example.com 70 | opensearch 71 | Search engine human-readable text description 72 | favicon.ico 73 | 74 | UTF-8 75 | 76 | """ 77 | result: HttpResponse = self.client.get( 78 | path=resolve_url(to="opensearch") 79 | ) 80 | 81 | self.assertXMLEqual(xml1=result.content.decode(), xml2=expected) 82 | 83 | @override_settings(OPENSEARCH_CONTACT_EMAIL="") 84 | @override_translation(language="en") 85 | def test_opensearch__render__without_email(self) -> None: 86 | """Test view rendering result without contact email.""" 87 | expected: str = """ 88 | 89 | opensearch 90 | Search engine human-readable text description 91 | favicon.ico 92 | 93 | UTF-8 94 | 95 | """ 96 | result: HttpResponse = self.client.get( 97 | path=resolve_url(to="opensearch") 98 | ) 99 | 100 | self.assertEqual( 101 | first=result.context.get("OPENSEARCH_CONTACT_EMAIL") 102 | if result.context 103 | else None, 104 | second="", 105 | ) 106 | self.assertXMLEqual(xml1=result.content.decode(), xml2=expected) 107 | 108 | @override_settings(OPENSEARCH_SHORT_NAME="") 109 | @override_translation(language="en") 110 | def test_opensearch__render__without_name(self) -> None: 111 | """Test view rendering result without short name.""" 112 | expected: str = """ 113 | 114 | test@example.com 115 | Search engine human-readable text description 116 | favicon.ico 117 | 118 | UTF-8 119 | 120 | """ 121 | result: HttpResponse = self.client.get( 122 | path=resolve_url(to="opensearch") 123 | ) 124 | 125 | self.assertEqual( 126 | first=result.context.get("OPENSEARCH_SHORT_NAME") 127 | if result.context 128 | else None, 129 | second="", 130 | ) 131 | self.assertXMLEqual(xml1=result.content.decode(), xml2=expected) 132 | 133 | @override_settings(OPENSEARCH_DESCRIPTION="") 134 | @override_translation(language="en") 135 | def test_opensearch__render__without_description(self) -> None: 136 | """Test view rendering result without description.""" 137 | expected: str = """ 138 | 139 | test@example.com 140 | opensearch 141 | favicon.ico 142 | 143 | UTF-8 144 | 145 | """ 146 | result: HttpResponse = self.client.get( 147 | path=resolve_url(to="opensearch") 148 | ) 149 | 150 | self.assertEqual( 151 | first=result.context.get("OPENSEARCH_DESCRIPTION") 152 | if result.context 153 | else None, 154 | second="", 155 | ) 156 | self.assertXMLEqual(xml1=result.content.decode(), xml2=expected) 157 | 158 | @override_settings( 159 | OPENSEARCH_FAVICON_WIDTH=0, 160 | OPENSEARCH_FAVICON_HEIGHT=0, 161 | OPENSEARCH_FAVICON_TYPE="", 162 | OPENSEARCH_FAVICON_FILE="", 163 | ) 164 | @override_translation(language="en") 165 | def test_opensearch__render__without_favicon(self) -> None: 166 | """Test view rendering result without favicon.""" 167 | expected: str = """ 168 | 169 | test@example.com 170 | opensearch 171 | Search engine human-readable text description 172 | 173 | UTF-8 174 | 175 | """ 176 | result: HttpResponse = self.client.get( 177 | path=resolve_url(to="opensearch") 178 | ) 179 | 180 | self.assertEqual( 181 | first=result.context.get("OPENSEARCH_FAVICON_WIDTH") 182 | if result.context 183 | else None, 184 | second=0, 185 | ) 186 | self.assertEqual( 187 | first=result.context.get("OPENSEARCH_FAVICON_HEIGHT") 188 | if result.context 189 | else None, 190 | second=0, 191 | ) 192 | self.assertEqual( 193 | first=result.context.get("OPENSEARCH_FAVICON_TYPE") 194 | if result.context 195 | else None, 196 | second="", 197 | ) 198 | self.assertEqual( 199 | first=result.context.get("OPENSEARCH_FAVICON_FILE") 200 | if result.context 201 | else None, 202 | second="", 203 | ) 204 | self.assertXMLEqual(xml1=result.content.decode(), xml2=expected) 205 | 206 | @override_settings(OPENSEARCH_SEARCH_URL="", OPENSEARCH_SEARCH_QUERYSTRING="") 207 | @override_translation(language="en") 208 | def test_opensearch__render__without_url(self) -> None: 209 | """ 210 | Test view rendering result without url. 211 | 212 | Must raise no reverse match error for empty URL name. 213 | """ 214 | with self.assertRaises(expected_exception=NoReverseMatch): 215 | self.client.get(path=resolve_url(to="opensearch")) 216 | 217 | @override_settings(OPENSEARCH_INPUT_ENCODING="") 218 | @override_translation(language="en") 219 | def test_opensearch__render__without_encoding(self) -> None: 220 | """Test view rendering result without input encoding.""" 221 | expected: str = """ 222 | 223 | test@example.com 224 | opensearch 225 | Search engine human-readable text description 226 | favicon.ico 227 | 228 | 229 | """ 230 | 231 | result: HttpResponse = self.client.get( 232 | path=resolve_url(to="opensearch") 233 | ) 234 | 235 | self.assertEqual( 236 | first=result.context.get("OPENSEARCH_INPUT_ENCODING") 237 | if result.context 238 | else None, 239 | second="", 240 | ) 241 | self.assertXMLEqual(xml1=result.content.decode(), xml2=expected) 242 | --------------------------------------------------------------------------------