Skip to main content

interactions-help

ipy

WIP: This extension is currently work-in-progress, which means it might not function well.

Installation

Install from PyPi

pip install -U interactions-help

Install from github

pip install git+https://github.com/ItsRqtl/interactions-help.git

Build from source

git clone https://github.com/ItsRqtl/interactions-help.git
cd interactions-help
pip install .

Usage

Loading the extension

from interactions import Client

client = Client(token="...")

client.load("interactions.ext.help")

client.start()

Default configuration

image

Configurate the help command

To configurate the help command, simply pass the values when you load the extension.

client.load("interactions.ext.help", embed_color=0x00FF00, ephemeral=True, subcommands=True)

Pagination

Do you have a long list of commands? Now you can paginate it with dinteractions-paginator! To paginate the help command, put pagination=True when you load the extension.

client.load("interactions.ext.help", pagination=True)

To customize the paginator, do the following:

from interactions.ext.help import PaginatorFormat
...
client.load("interactions.ext.help", pagination=True, paginator_format=PaginatorFormat(...))

PaginatorFormat has exactly the same params as Paginator except:

  • it does not take func_before_edit and func_after_edit
  • use_select is forced to be False (the title is the same across pages)
  • client and ctx will be applied itself

Parameters for client.load

Parameter Type Description Default value
consider_scope Optional[bool] Only show commands that is available in guild True
consider_permissions Optional[bool] Only show commands that the user can use True
embed_title Optional[str] Title of the embed Help
embed_description Optional[str] Description of the embed Here is a list of all commands
embed_color Optional[int] Color of the embed 0x000000
embed_footer Optional[EmbedFooter] Footer of the embed None
embed_timestamp Optional[bool] Whether to add a timestamp to the embed False
ephemeral Optional[bool] Whether the response is ephemeral (ignored if pagination is enabled) False
subcommands Optional[bool] Whether to show subcommands True
ignore_class Optional[List[str]] List of names of extension class to ignore []
ignore_command Optional[list[str]] List of names of commands to ignore []
pagination Optional[bool] Whether to paginate the help command False
paginator_format Optional[PaginatorFormat] Format of the paginator (ignored if pagination is disabled) PaginatorFormat()
no_category Optional[str] Name of the category for commands with no category (not in a class) No category

Metadata

Release files for interactions-help 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for interactions-help 0.0.5
File Size Uploaded
interactions-help-0.0.5.tar.gz 6.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for interactions-help 0.0.5
File Interpreter ABI Platform
interactions_help-0.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 12.7 kB

Release files / interactions-help-0.0.5.tar.gz

Download URL interactions-help-0.0.5.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
375d1280fb2941f26f79c00be935604fea8f6487ed19e3f9326c585af6d7f0f4
BLAKE2b-256 checksum
How to use checksums
cbab83baad2e8309535ba046a7b1e117a6e9ee53e1112870c98e6fe27d786a47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.4

Release files / interactions_help-0.0.5-py3-none-any.whl

Download URL interactions_help-0.0.5-py3-none-any.whl
Size 6.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fc8a2f99b8abbd584bc5df2487026bcadf60b48df882cb7fac582acc0e113d55
BLAKE2b-256 checksum
How to use checksums
86fed74af3302f04ab2fcf84906f401151bd46787bdb4879a278f0585f18f076
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.4

Release history Release notifications | RSS feed

This release

0.0.5 This release

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page