Unofficial Dynamic Help Command for interactions.py
Project description
Dynamic Help
Description
A dynamically generated help command for interactions.py that allows for >100 character command descriptions
Usage
Install via pypi
pip install interactions-dynamic-help
Then load the extension into your bot
from interactions import Client
bot = Client()
...
bot.load_extension("interactions.ext.dynhelp")
bot.start("Token")
Using longer descriptions
Longer description is done with a docstring.
If you are using a docstring longer than 100 chars, you MUST provide a description in the slash_command, otherwise the docstring will be used as the description
from interactions import Client, slash_command
bot = Client()
@slash_command(
name="test",
description="This is a test command",
)
async def test(ctx):
"""This is a test command (parsed as a short description and ignored if a long description is provided)
This is a longer description that will be used in the help command and is longer than 100 chars
- this is parsed as part of the long description
"""
await ctx.respond("Test")
bot.load_extension("interactions.ext.dynhelp")
bot.start("Token")
You can specify to combine the short and long description by adding combine=True
to the decorator
bot.load_extension("interactions.ext.dynhelp", combine=True)
Skipping commands and/or options
By defualt the ctx
and bot
parameters are skipped, but you can skip more by adding skip_coms
adn skip_opts
to
the decorator
bot.load_extension("interactions.ext.dynhelp", skip_coms=["test"], skip_opts=["test"])
Custom args to the paginator
These can be added by adding paginator_args
to the decorator, your args will be added to the default args which are
{
"ephemeral": true,
"delete_after": 60
}
bot.load_extension("interactions.ext.dynhelp", paginator_args={"timeout": 60})
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
Built Distribution
Hashes for interactions_dynamic_help-1.0.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a701bf46611e14f30eec0ae3c9cbb90fbc305195f866a7c7d08304da4c43f28d |
|
MD5 | 459f91db48d32b1994e36783d26a3471 |
|
BLAKE2b-256 | dcbc0d29d305a13bda371f7bafaf1239bb7270553d2068232e193627afbc5959 |
Hashes for interactions_dynamic_help-1.0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b2bf4b9800a06c782e921f824828bf9243e186a0361c6be759c84dce7b0a230 |
|
MD5 | b752e315673120c2e2a93cac201f83c7 |
|
BLAKE2b-256 | 06d044b652a2ecf5ce4d4480021ecc74a6230f9bbedd310c1913f14b5b8aecdd |