{"id":43513728,"url":"https://github.com/hypergonial/hikari-miru","last_synced_at":"2026-02-03T13:17:21.944Z","repository":{"id":42365512,"uuid":"448465009","full_name":"hypergonial/hikari-miru","owner":"hypergonial","description":"A component handler for hikari, inspired by discord.py's views.","archived":false,"fork":false,"pushed_at":"2025-07-05T21:14:08.000Z","size":1138,"stargazers_count":78,"open_issues_count":7,"forks_count":18,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-08T09:56:53.545Z","etag":null,"topics":["discord","discord-bot","discord-components","hikari","hikari-miru","hikari-py"],"latest_commit_sha":null,"homepage":"https://miru.hypergonial.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hypergonial.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"hypergonial"}},"created_at":"2022-01-16T05:23:06.000Z","updated_at":"2025-09-03T15:21:05.000Z","dependencies_parsed_at":"2023-07-22T07:49:34.148Z","dependency_job_id":"dbdcbe89-188f-454a-b4d8-d00b5f1ebdf3","html_url":"https://github.com/hypergonial/hikari-miru","commit_stats":null,"previous_names":["hypergonial/hikari-miru","hypergh/hikari-miru"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/hypergonial/hikari-miru","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Fhikari-miru","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Fhikari-miru/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Fhikari-miru/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Fhikari-miru/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypergonial","download_url":"https://codeload.github.com/hypergonial/hikari-miru/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypergonial%2Fhikari-miru/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29046503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discord","discord-bot","discord-components","hikari","hikari-miru","hikari-py"],"created_at":"2026-02-03T13:17:20.684Z","updated_at":"2026-02-03T13:17:21.929Z","avatar_url":"https://github.com/hypergonial.png","language":"Python","funding_links":["https://github.com/sponsors/hypergonial"],"categories":[],"sub_categories":[],"readme":"# hikari-miru\n\n\u003cdiv align=\"center\"\u003e\n\n[![PyPI](https://img.shields.io/pypi/v/hikari-miru)](https://pypi.org/project/hikari-miru)\n[![CI](https://github.com/hypergonial/hikari-miru/actions/workflows/ci.yml/badge.svg)](https://github.com/hypergonial/hikari-miru/actions/workflows/ci.yml)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n![Pyright](https://badgen.net/badge/Pyright/strict/2A6DB2)\n\n\u003c/div\u003e\n\nA component handler for [hikari](https://github.com/hikari-py/hikari), aimed at making the creation \u0026 management of Discord UI components easy.\n\n\u003e [!TIP]\n\u003e Like what you see? Check out [arc](https://arc.hypergonial.com), a command handler with a focus on type-safety and correctness.\n\n## Installation\n\nTo install miru, run the following command:\n\n```sh\npip install -U hikari-miru\n```\n\nTo check if miru has successfully installed or not, run the following:\n\n```sh\npython3 -m miru\n# On Windows you may need to run:\npy -m miru\n```\n\n## Usage\n\n```py\nimport hikari\nimport miru\n\n# REST bots are also supported\nbot = hikari.GatewayBot(token=\"...\")\n\n# Wrap the bot in a miru client\nclient = miru.Client(bot)\n\nclass MyView(miru.View):\n\n    @miru.button(label=\"Rock\", emoji=\"\\N{ROCK}\", style=hikari.ButtonStyle.PRIMARY)\n    async def rock_button(self, ctx: miru.ViewContext, button: miru.Button) -\u003e None:\n        await ctx.respond(\"Paper!\")\n\n    @miru.button(label=\"Paper\", emoji=\"\\N{SCROLL}\", style=hikari.ButtonStyle.PRIMARY)\n    async def paper_button(self, ctx: miru.ViewContext, button: miru.Button) -\u003e None:\n        await ctx.respond(\"Scissors!\")\n\n    @miru.button(label=\"Scissors\", emoji=\"\\N{BLACK SCISSORS}\", style=hikari.ButtonStyle.PRIMARY)\n    async def scissors_button(self, ctx: miru.ViewContext,  button: miru.Button) -\u003e None:\n        await ctx.respond(\"Rock!\")\n\n    @miru.button(emoji=\"\\N{BLACK SQUARE FOR STOP}\", style=hikari.ButtonStyle.DANGER, row=1)\n    async def stop_button(self, ctx: miru.ViewContext, button: miru.Button) -\u003e None:\n        self.stop() # Stop listening for interactions\n\n\n@bot.listen()\nasync def buttons(event: hikari.GuildMessageCreateEvent) -\u003e None:\n\n    # Ignore bots or webhooks pinging us\n    if not event.is_human:\n        return\n\n    me = bot.get_me()\n\n    # If the bot is mentioned\n    if me.id in event.message.user_mentions_ids:\n        view = MyView()  # Create a new view\n        # Send the view as message components\n        await event.message.respond(\"Rock Paper Scissors!\", components=view)\n        client.start_view(view) # Attach to the client \u0026 start it\n\nbot.run()\n```\n\nTo get started with `miru`, see the [documentation](https://miru.hypergonial.com), or the [examples](https://github.com/hypergonial/hikari-miru/tree/main/examples).\n\n## Extensions\n\nmiru has two extensions built-in:\n\n- [`ext.nav`](https://miru.hypergonial.com/guides/navigators/) - To make it easier to build navigators (sometimes called paginators).\n- [`ext.menu`](https://miru.hypergonial.com/guides/menus/) - To make it easier to create nested menus.\n\nCheck the corresponding documentation and the [examples](https://github.com/hypergonial/hikari-miru/tree/main/examples) on how to use them.\n\n## Issues and support\n\nFor general usage help or questions, see the `#miru` channel in the [hikari discord](https://discord.gg/hikari), if you have found a bug or have a feature request, feel free to [open an issue](https://github.com/hypergonial/hikari-miru/issues/new)!\n\n## Contributing\n\nSee [Contributing](./CONTRIBUTING.md)\n\n## Links\n\n- [**Documentation**](https://miru.hypergonial.com)\n- [**Examples**](https://github.com/hypergonial/hikari-miru/tree/main/examples)\n- [**License**](https://github.com/hypergonial/hikari-miru/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypergonial%2Fhikari-miru","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypergonial%2Fhikari-miru","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypergonial%2Fhikari-miru/lists"}