| Name | sopel-rtfm JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | None |
| Summary | A plugin to suggest documentation links when someone asks a basic question. |
| upload_time | 2024-11-28 01:52:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.8 |
| license | EFL-2.0 |
| keywords |
sopel
plugin
bot
irc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sopel-rtfm
A plugin to suggest documentation links when someone asks a basic question.
## Installing
This plugin is built for Sopel 8.0+.
Releases are hosted on PyPI, so after installing Sopel, all you need is `pip`:
```shell
$ pip install sopel-rtfm
```
### Optional extras
Optionally, you can install `sphobjinv[speedup]` for faster searches; this may
or may not work depending on whether your installation of Python includes the
necessary dependencies for building C extensions.
## Configuring
The easiest way to configure `sopel-rtfm` is via Sopel's configuration
wizard—simply run `sopel-plugins configure rtfm` and enter the values for which
it prompts you.
Two settings exist, one of which is required:
```ini
[rtfm]
# Required: URL of the objects.inv file you want `.rtfm` to search
inventory = https://docs.project.site/objects.inv
# Optional, but useful if automatically determining the base URL doesn't work
link_base = https://docs.project.site/
```
## Using
`sopel-rtfm` provides one command:
* `.rtfm` — searches the configured Sphinx object inventory for the best match,
and outputs a link to its documentation.
## Changelog
### 0.5.0
Changed:
* Require Sopel 8.0+ (#4)
* Minimum Python version is therefore now 3.8
* Improve logging of inventory & URL settings at startup (#5)
Meta:
* Packaging modernized: goodbye `setup.cfg`, hello `pyproject.toml` (#4)
* Cleaned up some deprecated usage (`sopel.module`, `datetime.utcnow()`)
* Tweaked config wizard prompt punctuation
### 0.4.0
Added:
* `.docs` command alias, for when `.rtfm` feels harsh (#2)
### 0.3.0
Added:
* Proper help output for `.rtfm` command (#1)
Changed:
* Prioritize "bigger" object types when sorting results
* Simplify retrieving output URL
### 0.2.0
Added:
* Caching behavior: The configured Sphinx inventory is fetched at startup, and
re-fetched automatically every 24 hours
* Bot admins can force an update with the new `.rtfmupdate` command
### 0.1.1
Changed:
* Empty/missing query now outputs the docs' base URL instead of an error
Fixed:
* `rtfm_base` was left in `bot.memory` after `shutdown()`
### 0.1.0
Initial release.
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-rtfm",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "sopel, plugin, bot, irc",
"author": null,
"author_email": "dgw <dgw@technobabbl.es>",
"download_url": "https://files.pythonhosted.org/packages/9b/e7/b82ad88ff3b13445e89b674c432e74ddffd0b0222554898a176fa1e576f4/sopel_rtfm-0.5.0.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-rtfm\n\nA plugin to suggest documentation links when someone asks a basic question.\n\n## Installing\n\nThis plugin is built for Sopel 8.0+.\n\nReleases are hosted on PyPI, so after installing Sopel, all you need is `pip`:\n\n```shell\n$ pip install sopel-rtfm\n```\n\n### Optional extras\n\nOptionally, you can install `sphobjinv[speedup]` for faster searches; this may\nor may not work depending on whether your installation of Python includes the\nnecessary dependencies for building C extensions.\n\n\n## Configuring\n\nThe easiest way to configure `sopel-rtfm` is via Sopel's configuration\nwizard\u2014simply run `sopel-plugins configure rtfm` and enter the values for which\nit prompts you.\n\nTwo settings exist, one of which is required:\n\n```ini\n[rtfm]\n# Required: URL of the objects.inv file you want `.rtfm` to search\ninventory = https://docs.project.site/objects.inv\n# Optional, but useful if automatically determining the base URL doesn't work\nlink_base = https://docs.project.site/\n```\n\n## Using\n\n`sopel-rtfm` provides one command:\n\n* `.rtfm` \u2014 searches the configured Sphinx object inventory for the best match,\n and outputs a link to its documentation.\n\n## Changelog\n\n### 0.5.0\n\nChanged:\n* Require Sopel 8.0+ (#4)\n * Minimum Python version is therefore now 3.8\n* Improve logging of inventory & URL settings at startup (#5)\n\nMeta:\n* Packaging modernized: goodbye `setup.cfg`, hello `pyproject.toml` (#4)\n * Cleaned up some deprecated usage (`sopel.module`, `datetime.utcnow()`)\n * Tweaked config wizard prompt punctuation\n\n\n### 0.4.0\n\nAdded:\n* `.docs` command alias, for when `.rtfm` feels harsh (#2)\n\n\n### 0.3.0\n\nAdded:\n* Proper help output for `.rtfm` command (#1)\n\nChanged:\n* Prioritize \"bigger\" object types when sorting results\n* Simplify retrieving output URL\n\n\n### 0.2.0\n\nAdded:\n* Caching behavior: The configured Sphinx inventory is fetched at startup, and\n re-fetched automatically every 24 hours\n* Bot admins can force an update with the new `.rtfmupdate` command\n\n\n### 0.1.1\n\nChanged:\n* Empty/missing query now outputs the docs' base URL instead of an error\n\nFixed:\n* `rtfm_base` was left in `bot.memory` after `shutdown()`\n\n\n### 0.1.0\n\nInitial release.\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "A plugin to suggest documentation links when someone asks a basic question.",
"version": "0.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/sopel-irc/sopel-rtfm/issues",
"Homepage": "https://github.com/sopel-irc/sopel-rtfm"
},
"split_keywords": [
"sopel",
" plugin",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a05962992bd35d208ffbbb68ff72de99dd4e059ea18a6c510444517a0bc5eea1",
"md5": "c804c625429dbc1cff6f42f8d21d5c9d",
"sha256": "873dcbf004c25afad1c705e80c8eef9e4b7c04491b5843c8c78ea165afd1f905"
},
"downloads": -1,
"filename": "sopel_rtfm-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c804c625429dbc1cff6f42f8d21d5c9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 5674,
"upload_time": "2024-11-28T01:52:58",
"upload_time_iso_8601": "2024-11-28T01:52:58.798233Z",
"url": "https://files.pythonhosted.org/packages/a0/59/62992bd35d208ffbbb68ff72de99dd4e059ea18a6c510444517a0bc5eea1/sopel_rtfm-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9be7b82ad88ff3b13445e89b674c432e74ddffd0b0222554898a176fa1e576f4",
"md5": "dad5bbc9d34ae58ac94e35969c38b04b",
"sha256": "c92712bd11a12d238b09c0a3a5325ee3b8da99442af03a849bc7561d65126661"
},
"downloads": -1,
"filename": "sopel_rtfm-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "dad5bbc9d34ae58ac94e35969c38b04b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 5401,
"upload_time": "2024-11-28T01:52:51",
"upload_time_iso_8601": "2024-11-28T01:52:51.530257Z",
"url": "https://files.pythonhosted.org/packages/9b/e7/b82ad88ff3b13445e89b674c432e74ddffd0b0222554898a176fa1e576f4/sopel_rtfm-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-28 01:52:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sopel-irc",
"github_project": "sopel-rtfm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sopel-rtfm"
}
