An alternative component handler for hikari, inspired by discord.py's views.
Project description
hikari-miru
An optional component handler for hikari, inspired by discord.py's views.
Installation
To install miru, run the following command:
python3 -m pip install -U hikari-miru
To check if miru has successfully installed or not, run the following:
python3 -m miru
Usage
import hikari
import miru
class MyView(miru.View):
@miru.button(label="Rock", emoji="\N{ROCK}", style=hikari.ButtonStyle.PRIMARY)
async def rock_button(self, button: miru.Button, ctx: miru.ViewContext) -> None:
await ctx.respond("Paper!")
@miru.button(label="Paper", emoji="\N{SCROLL}", style=hikari.ButtonStyle.PRIMARY)
async def paper_button(self, button: miru.Button, ctx: miru.ViewContext) -> None:
await ctx.respond("Scissors!")
@miru.button(label="Scissors", emoji="\N{BLACK SCISSORS}", style=hikari.ButtonStyle.PRIMARY)
async def scissors_button(self, button: miru.Button, ctx: miru.ViewContext) -> None:
await ctx.respond("Rock!")
@miru.button(emoji="\N{BLACK SQUARE FOR STOP}", style=hikari.ButtonStyle.DANGER, row=1)
async def stop_button(self, button: miru.Button, ctx: miru.ViewContext) -> None:
self.stop() # Stop listening for interactions
bot = hikari.GatewayBot(token="...")
miru.install(bot) # Load miru and attach it to the bot instance.
@bot.listen()
async def buttons(event: hikari.GuildMessageCreateEvent) -> None:
# Ignore bots or webhooks pinging us
if not event.is_human:
return
me = bot.get_me()
# If the bot is mentioned
if me.id in event.message.user_mentions_ids:
view = MyView(timeout=60) # Create a new view
message = await event.message.respond("Rock Paper Scissors!", components=view)
await view.start(message) # Start listening for interactions
await view.wait() # Optionally, wait until the view times out or gets stopped
await event.message.respond("Thank you for playing!")
bot.run()
For more examples see examples, or refer to the documentation.
Issues and support
For general usage help or questions, see the #miru
channel in the hikari discord, if you have found a bug or have a feature request, feel free to open an issue!
Contributing
If you wish to contribute, make sure to run nox before pushing your changes, and ensure all pipelines pass. This will format and typecheck your code to ensure it passes the CI.
Links
Project details
Release history Release notifications | RSS feed
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 hikari_miru-3.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67dc3351c6c598a91d57a8118d01cd2282b1ca11ea0836400d9bbeefcc2a0172 |
|
MD5 | b66706ac9eaf7b61eb6643ccc18e3bdf |
|
BLAKE2b-256 | 018a8af375c0e1ff88fe2f8c3e12c3fbe28529ff38b7b84c3c2a5b85d2ce130f |