| Name | sopel-search JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | Search plugin for Sopel IRC bots |
| upload_time | 2025-10-08 03:25:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.9 |
| license | None |
| keywords |
sopel
plugin
bot
irc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sopel-search
Search plugin for Sopel IRC bots
## Installing
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-search
```
This plugin is designed for use with Sopel version 8.0+, but may have a higher
minimum Python version requirement than Sopel itself due to upstream libraries.
## Configuring
The easiest way to configure `sopel-search` is via Sopel's configuration
wizard—simply run `sopel-plugins configure search` and enter the values for
which it prompts you. Available settings are:
* `region`: Set this to the primary geographical region of your bot's users,
using one of the values from https://duckduckgo.com/params
Setting this correctly may improve the relevance of both search results and
query suggestions using `.suggest`.
* `safesearch`: Controls SafeSearch filtering of `.search` results; one of 'on',
'moderate', and 'off'.
## Using
Two primary functions are available, `search` and `suggest`:
* `.search` (aliases: `.ddg`, `.g`): Perform a text search and return the top result
* `.suggest`: Fetch autocomplete suggestions for the stem of a search query
## Changelog
### 1.3.0
* Migrate DDGS library from 8.x to 9.x ([#9][])
* **Includes package name change to `ddgs`; the older `duckduckgo_search`
package is no longer used nor updated.**
* Fixed `.suggest` and merged it with `.gsuggest` ([#9][])
[#9]: https://github.com/sopel-irc/sopel-search/pull/9
### 1.2.0
* Upgrade DDGS library from 6.x to 8.x ([#6][])
* **This also required raising the minimum Python version to 3.9**
* Update package metadata for PEP 639 ([#7][])
[#6]: https://github.com/sopel-irc/sopel-search/pull/6
[#7]: https://github.com/sopel-irc/sopel-search/pull/7
### 1.1.0
* Handle common errors with some amount of grace ([#4][])
* Refresh the DDGS client periodically to reduce errors ([#5][])
[#4]: https://github.com/sopel-irc/sopel-search/pull/4
[#5]: https://github.com/sopel-irc/sopel-search/pull/5
### 1.0.1
Bump DuckDuckGo library minimum version; older releases stopped working.
### 1.0.0
First release of `sopel-search`.
This new search plugin apes a lot of behaviors from Sopel's built-in `search`,
with the following notable changes:
* `.bing` is no longer available
* `.search` is an alias to `.ddg`, as `.g` was already
* Search `region` and `safesearch` level are now configurable
* `.suggest` uses DuckDuckGo; Google suggestions are still available via the
new `.gsuggest` command (if optional extra dependencies are installed)
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-search",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "sopel, plugin, bot, irc",
"author": null,
"author_email": "dgw <dgw@technobabbl.es>",
"download_url": "https://files.pythonhosted.org/packages/8f/2d/5189ff029c9064e73acdd0058e08a8f06836f64a17c809d8c0f242d67dc1/sopel_search-1.3.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-search\n\nSearch plugin for Sopel IRC bots\n\n## Installing\n\nReleases are hosted on PyPI, so after installing Sopel, all you need is `pip`:\n\n```shell\n$ pip install sopel-search\n```\n\nThis plugin is designed for use with Sopel version 8.0+, but may have a higher\nminimum Python version requirement than Sopel itself due to upstream libraries.\n\n## Configuring\n\nThe easiest way to configure `sopel-search` is via Sopel's configuration\nwizard\u2014simply run `sopel-plugins configure search` and enter the values for\nwhich it prompts you. Available settings are:\n\n* `region`: Set this to the primary geographical region of your bot's users,\n using one of the values from https://duckduckgo.com/params\n\n Setting this correctly may improve the relevance of both search results and\n query suggestions using `.suggest`.\n* `safesearch`: Controls SafeSearch filtering of `.search` results; one of 'on',\n 'moderate', and 'off'.\n\n## Using\n\nTwo primary functions are available, `search` and `suggest`:\n\n* `.search` (aliases: `.ddg`, `.g`): Perform a text search and return the top result\n* `.suggest`: Fetch autocomplete suggestions for the stem of a search query\n\n## Changelog\n\n### 1.3.0\n\n* Migrate DDGS library from 8.x to 9.x ([#9][])\n * **Includes package name change to `ddgs`; the older `duckduckgo_search`\n package is no longer used nor updated.**\n* Fixed `.suggest` and merged it with `.gsuggest` ([#9][])\n\n[#9]: https://github.com/sopel-irc/sopel-search/pull/9\n\n\n### 1.2.0\n\n* Upgrade DDGS library from 6.x to 8.x ([#6][])\n * **This also required raising the minimum Python version to 3.9**\n* Update package metadata for PEP 639 ([#7][])\n\n[#6]: https://github.com/sopel-irc/sopel-search/pull/6\n[#7]: https://github.com/sopel-irc/sopel-search/pull/7\n\n\n### 1.1.0\n\n* Handle common errors with some amount of grace ([#4][])\n* Refresh the DDGS client periodically to reduce errors ([#5][])\n\n[#4]: https://github.com/sopel-irc/sopel-search/pull/4\n[#5]: https://github.com/sopel-irc/sopel-search/pull/5\n\n\n### 1.0.1\n\nBump DuckDuckGo library minimum version; older releases stopped working.\n\n\n### 1.0.0\n\nFirst release of `sopel-search`.\n\nThis new search plugin apes a lot of behaviors from Sopel's built-in `search`,\nwith the following notable changes:\n\n* `.bing` is no longer available\n* `.search` is an alias to `.ddg`, as `.g` was already\n* Search `region` and `safesearch` level are now configurable\n* `.suggest` uses DuckDuckGo; Google suggestions are still available via the\n new `.gsuggest` command (if optional extra dependencies are installed)\n",
"bugtrack_url": null,
"license": null,
"summary": "Search plugin for Sopel IRC bots",
"version": "1.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/sopel-irc/sopel-search/issues",
"Homepage": "https://github.com/sopel-irc/sopel-search"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d039045cda56f7cd6339e7b99437f142b7443c26fcd7f70f22dc5883602049ef",
"md5": "6ef6010f4ff367ed8713b48d9d53a06d",
"sha256": "1073485ce4591e061c34ac5f8a8403d3c6d96b6de27c9cdaac88e2873ca69cc3"
},
"downloads": -1,
"filename": "sopel_search-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ef6010f4ff367ed8713b48d9d53a06d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 6413,
"upload_time": "2025-10-08T03:25:56",
"upload_time_iso_8601": "2025-10-08T03:25:56.456626Z",
"url": "https://files.pythonhosted.org/packages/d0/39/045cda56f7cd6339e7b99437f142b7443c26fcd7f70f22dc5883602049ef/sopel_search-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8f2d5189ff029c9064e73acdd0058e08a8f06836f64a17c809d8c0f242d67dc1",
"md5": "8b4bc559be836da7272d6d47abc7ed7a",
"sha256": "ca5602929fa92b8dfa0073a88ff99a3903fe8ee53c07dbee35c05ed35286acdd"
},
"downloads": -1,
"filename": "sopel_search-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8b4bc559be836da7272d6d47abc7ed7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 5798,
"upload_time": "2025-10-08T03:25:57",
"upload_time_iso_8601": "2025-10-08T03:25:57.870426Z",
"url": "https://files.pythonhosted.org/packages/8f/2d/5189ff029c9064e73acdd0058e08a8f06836f64a17c809d8c0f242d67dc1/sopel_search-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 03:25:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sopel-irc",
"github_project": "sopel-search",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sopel-search"
}
