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:
$ 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:
[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, hellopyproject.toml(#4)- Cleaned up some deprecated usage (
sopel.module,datetime.utcnow()) - Tweaked config wizard prompt punctuation
- Cleaned up some deprecated usage (
0.4.0
Added:
.docscommand alias, for when.rtfmfeels harsh (#2)
0.3.0
Added:
- Proper help output for
.rtfmcommand (#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
.rtfmupdatecommand
0.1.1
Changed:
- Empty/missing query now outputs the docs' base URL instead of an error
Fixed:
rtfm_basewas left inbot.memoryaftershutdown()
0.1.0
Initial release.
Metadata
Release files for sopel-rtfm 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sopel_rtfm-0.5.0.tar.gz | 5.4 kB | Without provenance | Details for sopel_rtfm-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sopel_rtfm-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for sopel_rtfm-0.5.0-py3-none-any.whl |
Total release size: 11.1 kB
Release files / sopel_rtfm-0.5.0.tar.gz
| Download URL | sopel_rtfm-0.5.0.tar.gz |
|---|---|
| Size | 5.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c92712bd11a12d238b09c0a3a5325ee3b8da99442af03a849bc7561d65126661
|
|
BLAKE2b-256 checksum How to use checksums |
9be7b82ad88ff3b13445e89b674c432e74ddffd0b0222554898a176fa1e576f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / sopel_rtfm-0.5.0-py3-none-any.whl
| Download URL | sopel_rtfm-0.5.0-py3-none-any.whl |
|---|---|
| Size | 5.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
873dcbf004c25afad1c705e80c8eef9e4b7c04491b5843c8c78ea165afd1f905
|
|
BLAKE2b-256 checksum How to use checksums |
a05962992bd35d208ffbbb68ff72de99dd4e059ea18a6c510444517a0bc5eea1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Security for sopel-rtfm 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.