%global _empty_manifest_terminate_build 0 Name: python-discord-pretty-help Version: 2.0.0 Release: 1 Summary: And nicer looking interactive help menu for discord.py License: MIT URL: https://github.com/stroupbslayen/discord-pretty-help Source0: https://mirrors.nju.edu.cn/pypi/web/packages/00/23/2239a246c70fa57202961407b9c793abff62de1b3f624940388c6ebdc28c/discord_pretty_help-2.0.0.tar.gz BuildArch: noarch %description ![version](https://img.shields.io/pypi/v/discord-pretty-help) ![python](https://img.shields.io/badge/python-3.8+-blue) # discord-pretty-help An embed version of the built in help command for discord.py Inspired by the DefaultHelpCommand that discord.py uses, but revised for embeds and additional sorting on individual pages that can be "scrolled" through. ## Installation `pip install discord-pretty-help` ## Usage Example of how to use it: ```python from discord.ext import commands from pretty_help import PrettyHelp bot = commands.Bot(command_prefix="!", help_command=PrettyHelp()) ``` ### Added Optional Args - `color` - Set the default embed color - `delete_invoke` - Delete the message that invoked the help command. Requires message delete permission. Defaults is `False` - `ending_note` - Set the footer of the embed. Ending notes are fed a `commands.Context` (`ctx`) and a `PrettyHelp` (`help`) instance for more advanced customization. - `image_url` - The url of the image to be used on the embed - `index_title` - Set the index page name default is *"Categories"* - `menu` - The menu to use for navigating pages. Uses a `pretty_help.PrettyMenu()` instance. Default is `pretty_help.AppMenu()` - `no_category` - Set the name of the page with commands not part of a category. Default is "*No Category*" - `sort_commands` - Sort commands and categories alphabetically - `show_index` - Show the index page or not - `thumbnail_url` - The url of the thumbnail to be used on the emebed ## Menus ### pretty_help.EmojiMenu - Uses Emojis to navigate - `active_time` - Set the time (in seconds) that the message will be active. Default is 30s - `delete_after_timeout` - Delete the message after `active_time` instead of removing reactions. Default `False` - `page_left` - The emoji to use to page left - `page_right` - The emoji to use to page right - `remove` - The emoji to use to remove the help message ![example](/images/example-emoji.gif) ### pretty_help.AppMenu - Uses Application Interactions (buttons) for navigating - `timeout` - The duration the interaction will be active for. Defaults to `None`. - `ephemeral` - Send as an ephemeral message. Defaults to `False`. ![example](/images/example-app.gif) By default, the help will just pick a random color on every invoke. You can change this using the `color` argument: ### Example of using a different menu and customization: ```python from discord.ext import commands from pretty_help import EmojiMenu, PrettyHelp # ":discord:743511195197374563" is a custom discord emoji format. Adjust to match your own custom emoji. menu = EmojiMenu(page_left="\U0001F44D", page_right="👎", remove=":discord:743511195197374563", active_time=5) # Custom ending note ending_note = "The ending note from {ctx.bot.user.name}\nFor command {help.clean_prefix}{help.invoked_with}" bot = commands.Bot(command_prefix="!") bot.help_command = PrettyHelp(menu=menu, ending_note=ending_note) ``` The basic `help` command will break commands up by cogs. Each cog will be a different page. Those pages can be navigated. ![example](/images/example.gif) # Changelog ## [2.0.0] - Subcommands in pages are indicated with a 🔗, previously it was unclear they were sub commands of the page title - Support Application commands - Support for GroupCogs - Navigation using discord interactions eg. Buttons and select menus # Notes: - discord.py must already be installed to use this - `manage-messages` permission is recommended so reactions can be removed automatically ## Forks for other discord.py based libraries (maintanance not monitored): * [nextcord-pretty-help](https://github.com/squigjess/nextcord-pretty-help) %package -n python3-discord-pretty-help Summary: And nicer looking interactive help menu for discord.py Provides: python-discord-pretty-help BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-discord-pretty-help ![version](https://img.shields.io/pypi/v/discord-pretty-help) ![python](https://img.shields.io/badge/python-3.8+-blue) # discord-pretty-help An embed version of the built in help command for discord.py Inspired by the DefaultHelpCommand that discord.py uses, but revised for embeds and additional sorting on individual pages that can be "scrolled" through. ## Installation `pip install discord-pretty-help` ## Usage Example of how to use it: ```python from discord.ext import commands from pretty_help import PrettyHelp bot = commands.Bot(command_prefix="!", help_command=PrettyHelp()) ``` ### Added Optional Args - `color` - Set the default embed color - `delete_invoke` - Delete the message that invoked the help command. Requires message delete permission. Defaults is `False` - `ending_note` - Set the footer of the embed. Ending notes are fed a `commands.Context` (`ctx`) and a `PrettyHelp` (`help`) instance for more advanced customization. - `image_url` - The url of the image to be used on the embed - `index_title` - Set the index page name default is *"Categories"* - `menu` - The menu to use for navigating pages. Uses a `pretty_help.PrettyMenu()` instance. Default is `pretty_help.AppMenu()` - `no_category` - Set the name of the page with commands not part of a category. Default is "*No Category*" - `sort_commands` - Sort commands and categories alphabetically - `show_index` - Show the index page or not - `thumbnail_url` - The url of the thumbnail to be used on the emebed ## Menus ### pretty_help.EmojiMenu - Uses Emojis to navigate - `active_time` - Set the time (in seconds) that the message will be active. Default is 30s - `delete_after_timeout` - Delete the message after `active_time` instead of removing reactions. Default `False` - `page_left` - The emoji to use to page left - `page_right` - The emoji to use to page right - `remove` - The emoji to use to remove the help message ![example](/images/example-emoji.gif) ### pretty_help.AppMenu - Uses Application Interactions (buttons) for navigating - `timeout` - The duration the interaction will be active for. Defaults to `None`. - `ephemeral` - Send as an ephemeral message. Defaults to `False`. ![example](/images/example-app.gif) By default, the help will just pick a random color on every invoke. You can change this using the `color` argument: ### Example of using a different menu and customization: ```python from discord.ext import commands from pretty_help import EmojiMenu, PrettyHelp # ":discord:743511195197374563" is a custom discord emoji format. Adjust to match your own custom emoji. menu = EmojiMenu(page_left="\U0001F44D", page_right="👎", remove=":discord:743511195197374563", active_time=5) # Custom ending note ending_note = "The ending note from {ctx.bot.user.name}\nFor command {help.clean_prefix}{help.invoked_with}" bot = commands.Bot(command_prefix="!") bot.help_command = PrettyHelp(menu=menu, ending_note=ending_note) ``` The basic `help` command will break commands up by cogs. Each cog will be a different page. Those pages can be navigated. ![example](/images/example.gif) # Changelog ## [2.0.0] - Subcommands in pages are indicated with a 🔗, previously it was unclear they were sub commands of the page title - Support Application commands - Support for GroupCogs - Navigation using discord interactions eg. Buttons and select menus # Notes: - discord.py must already be installed to use this - `manage-messages` permission is recommended so reactions can be removed automatically ## Forks for other discord.py based libraries (maintanance not monitored): * [nextcord-pretty-help](https://github.com/squigjess/nextcord-pretty-help) %package help Summary: Development documents and examples for discord-pretty-help Provides: python3-discord-pretty-help-doc %description help ![version](https://img.shields.io/pypi/v/discord-pretty-help) ![python](https://img.shields.io/badge/python-3.8+-blue) # discord-pretty-help An embed version of the built in help command for discord.py Inspired by the DefaultHelpCommand that discord.py uses, but revised for embeds and additional sorting on individual pages that can be "scrolled" through. ## Installation `pip install discord-pretty-help` ## Usage Example of how to use it: ```python from discord.ext import commands from pretty_help import PrettyHelp bot = commands.Bot(command_prefix="!", help_command=PrettyHelp()) ``` ### Added Optional Args - `color` - Set the default embed color - `delete_invoke` - Delete the message that invoked the help command. Requires message delete permission. Defaults is `False` - `ending_note` - Set the footer of the embed. Ending notes are fed a `commands.Context` (`ctx`) and a `PrettyHelp` (`help`) instance for more advanced customization. - `image_url` - The url of the image to be used on the embed - `index_title` - Set the index page name default is *"Categories"* - `menu` - The menu to use for navigating pages. Uses a `pretty_help.PrettyMenu()` instance. Default is `pretty_help.AppMenu()` - `no_category` - Set the name of the page with commands not part of a category. Default is "*No Category*" - `sort_commands` - Sort commands and categories alphabetically - `show_index` - Show the index page or not - `thumbnail_url` - The url of the thumbnail to be used on the emebed ## Menus ### pretty_help.EmojiMenu - Uses Emojis to navigate - `active_time` - Set the time (in seconds) that the message will be active. Default is 30s - `delete_after_timeout` - Delete the message after `active_time` instead of removing reactions. Default `False` - `page_left` - The emoji to use to page left - `page_right` - The emoji to use to page right - `remove` - The emoji to use to remove the help message ![example](/images/example-emoji.gif) ### pretty_help.AppMenu - Uses Application Interactions (buttons) for navigating - `timeout` - The duration the interaction will be active for. Defaults to `None`. - `ephemeral` - Send as an ephemeral message. Defaults to `False`. ![example](/images/example-app.gif) By default, the help will just pick a random color on every invoke. You can change this using the `color` argument: ### Example of using a different menu and customization: ```python from discord.ext import commands from pretty_help import EmojiMenu, PrettyHelp # ":discord:743511195197374563" is a custom discord emoji format. Adjust to match your own custom emoji. menu = EmojiMenu(page_left="\U0001F44D", page_right="👎", remove=":discord:743511195197374563", active_time=5) # Custom ending note ending_note = "The ending note from {ctx.bot.user.name}\nFor command {help.clean_prefix}{help.invoked_with}" bot = commands.Bot(command_prefix="!") bot.help_command = PrettyHelp(menu=menu, ending_note=ending_note) ``` The basic `help` command will break commands up by cogs. Each cog will be a different page. Those pages can be navigated. ![example](/images/example.gif) # Changelog ## [2.0.0] - Subcommands in pages are indicated with a 🔗, previously it was unclear they were sub commands of the page title - Support Application commands - Support for GroupCogs - Navigation using discord interactions eg. Buttons and select menus # Notes: - discord.py must already be installed to use this - `manage-messages` permission is recommended so reactions can be removed automatically ## Forks for other discord.py based libraries (maintanance not monitored): * [nextcord-pretty-help](https://github.com/squigjess/nextcord-pretty-help) %prep %autosetup -n discord-pretty-help-2.0.0 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-discord-pretty-help -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Mon Apr 10 2023 Python_Bot - 2.0.0-1 - Package Spec generated