# discord.ext.help
> [!NOTE]
> The specification has changed from the legacy version (0.x), and this library now only supports help generation for application commands.
>
A discord.py extension that automatically generates interaction help commands.
## Dependency
- [Defxult/reactionmenu](https://github.com/Defxult/reactionmenu)
- discord.py 2.0 and later
This library is not guaranteed to be compatible with the discord.py fork (Because the reactionmenu used in this library is probably dedicated to discord.py).
Also, for pycord, you can reproduce the behavior of this library by using [`discord.ext.pages`](https://docs.pycord.dev/en/stable/ext/pages/index.html).
## How To Use
### Install
```
pip install discord-ext-help
```
### example
```python
import discord
from discord.ext import commands
from discord_ext_help.help import extension as helpext
bot = commands.Bot(command_prefix="!", intents=discord.Intents.all())
deh = helpext(bot)
@bot.event
async def setup_hook():
command = await bot.tree.sync()
await deh.regist_ids(command)
@bot.tree.command(
name="help", description="show help"
)
async def help(interaction: discord.Interaction):
await interaction.response.defer()
await generate(interaction)
bot.run(token)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sonyakun/discord-ext-help",
"name": "discord-ext-help",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "sonyakun",
"author_email": "owner@sonyakun.com",
"download_url": "https://files.pythonhosted.org/packages/32/0f/b64ffeffe6602a88a32e3ecdd43524af161f68351ed5792b1d436f541fd8/discord_ext_help-1.0.1.tar.gz",
"platform": null,
"description": "# discord.ext.help\n> [!NOTE]\n> The specification has changed from the legacy version (0.x), and this library now only supports help generation for application commands.\n> \nA discord.py extension that automatically generates interaction help commands.\n\n## Dependency\n- [Defxult/reactionmenu](https://github.com/Defxult/reactionmenu)\n- discord.py 2.0 and later \n\nThis library is not guaranteed to be compatible with the discord.py fork (Because the reactionmenu used in this library is probably dedicated to discord.py).\n\nAlso, for pycord, you can reproduce the behavior of this library by using [`discord.ext.pages`](https://docs.pycord.dev/en/stable/ext/pages/index.html).\n\n## How To Use\n### Install\n```\npip install discord-ext-help\n```\n### example\n```python\nimport discord\nfrom discord.ext import commands\nfrom discord_ext_help.help import extension as helpext\n\nbot = commands.Bot(command_prefix=\"!\", intents=discord.Intents.all())\ndeh = helpext(bot)\n\n@bot.event\nasync def setup_hook():\n command = await bot.tree.sync()\n await deh.regist_ids(command)\n\n@bot.tree.command(\n name=\"help\", description=\"show help\"\n)\nasync def help(interaction: discord.Interaction):\n await interaction.response.defer()\n await generate(interaction)\n\nbot.run(token)\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A discord.py extension that automatically generates interaction help commands.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/sonyakun/discord-ext-help",
"Repository": "https://github.com/sonyakun/discord-ext-help"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27bffe165ab9b9ab50a98d09f408fcecba996c8cef700dbe529aa1f99d4b74de",
"md5": "6f25ec02f39711a00b13f3a908bd072b",
"sha256": "ca9acc912c53dce5b8a518a57245ade3edac360f006926c8869f3103c4da150f"
},
"downloads": -1,
"filename": "discord_ext_help-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f25ec02f39711a00b13f3a908bd072b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 6073,
"upload_time": "2024-03-08T19:04:34",
"upload_time_iso_8601": "2024-03-08T19:04:34.890415Z",
"url": "https://files.pythonhosted.org/packages/27/bf/fe165ab9b9ab50a98d09f408fcecba996c8cef700dbe529aa1f99d4b74de/discord_ext_help-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "320fb64ffeffe6602a88a32e3ecdd43524af161f68351ed5792b1d436f541fd8",
"md5": "059694cc9ed8f93dd745f35d016139c6",
"sha256": "8b076864871dcad7c40b70fc65d9bb4b900b6964c0b21fba0644934cbd40e517"
},
"downloads": -1,
"filename": "discord_ext_help-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "059694cc9ed8f93dd745f35d016139c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4488,
"upload_time": "2024-03-08T19:04:36",
"upload_time_iso_8601": "2024-03-08T19:04:36.418900Z",
"url": "https://files.pythonhosted.org/packages/32/0f/b64ffeffe6602a88a32e3ecdd43524af161f68351ed5792b1d436f541fd8/discord_ext_help-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 19:04:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sonyakun",
"github_project": "discord-ext-help",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "discord-ext-help"
}
JSON
