hikari-miru
A component handler for hikari, aimed at making the creation & management of Discord UI components easy.
[!TIP] Like what you see? Check out arc, a command handler with a focus on type-safety and correctness.
Installation
To install miru, run the following command:
pip install -U hikari-miru
To check if miru has successfully installed or not, run the following:
python3 -m miru
# On Windows you may need to run:
py -m miru
Usage
import hikari
import miru
# REST bots are also supported
bot = hikari.GatewayBot(token="...")
# Wrap the bot in a miru client
client = miru.Client(bot)
class MyView(miru.View):
@miru.button(label="Rock", emoji="\N{ROCK}", style=hikari.ButtonStyle.PRIMARY)
async def rock_button(self, ctx: miru.ViewContext, button: miru.Button) -> None:
await ctx.respond("Paper!")
@miru.button(label="Paper", emoji="\N{SCROLL}", style=hikari.ButtonStyle.PRIMARY)
async def paper_button(self, ctx: miru.ViewContext, button: miru.Button) -> None:
await ctx.respond("Scissors!")
@miru.button(label="Scissors", emoji="\N{BLACK SCISSORS}", style=hikari.ButtonStyle.PRIMARY)
async def scissors_button(self, ctx: miru.ViewContext, button: miru.Button) -> None:
await ctx.respond("Rock!")
@miru.button(emoji="\N{BLACK SQUARE FOR STOP}", style=hikari.ButtonStyle.DANGER, row=1)
async def stop_button(self, ctx: miru.ViewContext, button: miru.Button) -> None:
self.stop() # Stop listening for interactions
@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() # Create a new view
# Send the view as message components
await event.message.respond("Rock Paper Scissors!", components=view)
client.start_view(view) # Attach to the client & start it
bot.run()
To get started with miru, see the documentation, or the examples.
Extensions
miru has two extensions built-in:
ext.nav- To make it easier to build navigators (sometimes called paginators).ext.menu- To make it easier to create nested menus.
Check the corresponding documentation and the examples on how to use them.
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
See Contributing
Links
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hikari_miru-4.3.1.tar.gz.
File metadata
- Download URL: hikari_miru-4.3.1.tar.gz
- Upload date:
- Size: 365.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
923298d8a6bd5c1c7d8c8a9e33a8faf3cd6dc889787017c48383b00dffd2359f
|
|
| MD5 |
bacaa2e710993a76a38b9f89ec51b7e9
|
|
| BLAKE2b-256 |
22bb451546aac01fdd6246d82a5d8117c57e5e3c26593bd32a6fe4b28afbee2a
|
File details
Details for the file hikari_miru-4.3.1-py3-none-any.whl.
File metadata
- Download URL: hikari_miru-4.3.1-py3-none-any.whl
- Upload date:
- Size: 90.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e315d3096b549466c83cafd7f40d543ca865fd64b5d24c2b8b0952329288c7ed
|
|
| MD5 |
4892ab6a38e89a964579767c4f6ddf5b
|
|
| BLAKE2b-256 |
e099cd84e841a9b215f18839086823eca38744cf107938792d862034d9370b71
|
