==========
sopel-help
==========
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.8+ 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
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-help",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "dgw <dgw@technobabbl.es>, Florian Strzelecki <florian.strzelecki@gmail.com>",
"keywords": "sopel, irc, help, doc, plugin",
"author": null,
"author_email": "dgw <dgw@technobabbl.es>, Florian Strzelecki <florian.strzelecki@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/14/d8/4308f004920880f742db9c1e1853503857c6884e48e63f977c0e7a0bfd60/sopel_help-0.5.2.tar.gz",
"platform": "Linux x86, x86-64",
"description": "==========\nsopel-help\n==========\n\nSopel plugin ``.help`` command::\n\n [Exirel]: .help help\n [Sopel]: Generate help for Sopel's commands.\n [Sopel]: e.g. .help help or .help\n\nInstall\n=======\n\nThe recommanded way to install this plugin is to use ``pip``::\n\n $ pip install sopel-help\n\nNote that this plugin requires Python 3.8+ and Sopel 7.1+.\n\nConfigure\n=========\n\nAs with many other plugins, you can use ``sopel-config`` to launch the\nconfiguration wizard, like so::\n\n $ sopel-plugins configure help\n\nDon't forget to use the ``-c <config-name>`` option to select the right config.\n\nProviders\n=========\n\nThere are several providers built-in with this plugin:\n\n* ``base`` (the default): basic provider; it outputs help directly to the user\n* ``local``: it generates an HTML file and outputs an URL; you have to\n install and configure your own origin server to serve that file\n* ``clbin``, ``0x0``, ``termbin``: all these providers post a plain-text file\n to a pastebin service and then output the resulting URL\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "Help plugin for Sopel",
"version": "0.5.2",
"project_urls": {
"Bug Tracker": "https://github.com/sopel-irc/sopel-help/issues",
"Source": "https://github.com/sopel-irc/sopel-help"
},
"split_keywords": [
"sopel",
" irc",
" help",
" doc",
" plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "127e98ba6285c31f74daa3748d413f902684fd6890bbbbbfdd66b84f5cb9f5bc",
"md5": "b88a6cbb6cbe879accf20bb656e634e4",
"sha256": "6af20b49db4bd3ff05bfa9accff1f9ac315743945aaa3f0c032d4990962c3b86"
},
"downloads": -1,
"filename": "sopel_help-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b88a6cbb6cbe879accf20bb656e634e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11380,
"upload_time": "2024-10-21T17:29:30",
"upload_time_iso_8601": "2024-10-21T17:29:30.595455Z",
"url": "https://files.pythonhosted.org/packages/12/7e/98ba6285c31f74daa3748d413f902684fd6890bbbbbfdd66b84f5cb9f5bc/sopel_help-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14d84308f004920880f742db9c1e1853503857c6884e48e63f977c0e7a0bfd60",
"md5": "7ed6f0c11ce2365bed63918d434d9c44",
"sha256": "11cb0cfa15f98902140341871d7b5299fb7a541b4774a081903bb4bed38badff"
},
"downloads": -1,
"filename": "sopel_help-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "7ed6f0c11ce2365bed63918d434d9c44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15032,
"upload_time": "2024-10-21T17:29:31",
"upload_time_iso_8601": "2024-10-21T17:29:31.812533Z",
"url": "https://files.pythonhosted.org/packages/14/d8/4308f004920880f742db9c1e1853503857c6884e48e63f977c0e7a0bfd60/sopel_help-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 17:29:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sopel-irc",
"github_project": "sopel-help",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "flake8",
"specs": []
},
{
"name": "pylint",
"specs": [
[
"<",
"3"
]
]
},
{
"name": "coverage",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "requests-mock",
"specs": []
},
{
"name": "pyroma",
"specs": []
},
{
"name": "twine",
"specs": []
}
],
"lcname": "sopel-help"
}
JSON
