help: replace with dependency on sopel-help

[Exirel]

Description

Fix #1212 by proxy.

Make the built-in help plugin obsolete with warning in its setup() hook and all rules have been removed (rules & commands), and installing Sopel now requires sopel-help.

Since it is possible to install a package without its dependencies, I kept help.py so users can have a warning. It isn't much, but it might help someone.

This is based of #2342 for Python 3.10.

Thank you for your service, help, you will be remembered.

Checklist

• I have read CONTRIBUTING.md
• I can and do license this contribution under the EFLv2
• No issues are reported by make qa (runs make quality and make test)
• I have tested the functionality of the things this change touches

[dgw]

Are the internals that help/sopel-help use well-enough documented that someone could easily make a custom equivalent? (Not talking about adding e.g. paste backends to sopel-help, but an actual full-on replacement.)

Otherwise, I'm 👎 on replacing an essential built-in plugin like this with a no-op. Moving to package it separately (so it can be updated independently of core) is fine, but core should require it.

[Exirel]

Are the internals that help/sopel-help use well-enough documented that someone could easily make a custom equivalent?

Not yet! This is in the work with Sopel 8, by replacing the hard-coded dict and stuffs like that by the Rule Managers, which could be the origin of a new chapter in "advanced tips & tricks" in the documentation.

core should require it.

Alright then! Waiting on #2328 first, then I'll add it to the list of install-requires. 😁

[dgw]

You know, the irony here is that I was ready to merge this despite the use of "module" because it's unlikely that most users would ever see it. But because you rebased it onto another PR that isn't merged yet, I have to wait, and so do you. 😝

(If you wait until #2342 goes in before amending this one, the UI will be less confusing. The extra commits will disappear after you force-push, but only if they've been merged.)

[dgw]

Oh, I just had another (possibly stupid) idea: Could help.py be moved to some other place called "shims" or similar, so we have a place for this and other plugins that are moved out of core but still want to keep around with warnings like this for a bit?

Obviously I know it can, but is the idea good? 😛

[dgw]

Wait is over; #2342 has been merged. Amend away, and soon ye shall receive another merge. 😁

[Exirel]

Done. I had to fix the message, and decided to keep a single \' because I could have that or use double quotes and use two \" for the last line.

[dgw]

and decided to keep a single \' because I could have that or use double quotes and use two \" for the last line.

Maybe you forgot that the below totally works 😁 but it's totally a choice between two almost equally annoying alternatives (mixed quotes vs. escapes). The third option would be using double quotes and wrapping the command in something else, maybe backticks.

Anyway, I'm already over it.

>>> print(
...     "Sopel's built-in help plugin is obsolete. "
...     'Install sopel-help as the official help plugin for Sopel.\n'
...     'You can install sopel-help with "pip install sopel-help".')
Sopel's built-in help plugin is obsolete. Install sopel-help as the official help plugin for Sopel.
You can install sopel-help with "pip install sopel-help".

[Exirel]

I did not. I remembered that you didn't like that syntax on my attempt at using flake8-quotes, mixing " and ' in multi-lines.

[dgw]

Well, I don't. But I also don't like escapes. But this is also almost never going to be seen by anyone, until its eventual deletion in 9.0 or whatever, so again: I'm over it. 😁 😹