Skip to main content

Help plugin for Sopel

Project description

Sopel plugin .help command:

[Exirel]: .help help
[Sopel]: Generate help for Sopel's commands.
[Sopel]: e.g. .help help or .help

Install

The recommanded way to install this plugin is to use pip:

$ pip install sopel-help

Note that this plugin requires Python 3.7+ and Sopel 7.1+.

Configure

As with many other plugins, you can use sopel-config to launch the configuration wizard, like so:

$ sopel-plugins configure help

Don’t forget to use the -c <config-name> option to select the right config.

Providers

There are several providers built-in with this plugin:

  • base (the default): basic provider; it outputs help directly to the user

  • local: it generates an HTML file and outputs an URL; you have to install and configure your own origin server to serve that file

  • clbin, 0x0, termbin: all these providers post a plain-text file to a pastebin service and then output the resulting URL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sopel-help-0.4.0.tar.gz (10.5 kB view hashes)

Uploaded source

Built Distribution

sopel_help-0.4.0-py3-none-any.whl (11.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page