{"id":21980051,"url":"https://github.com/parafoxia/hikari-intro","last_synced_at":"2025-04-30T04:35:33.681Z","repository":{"id":46009766,"uuid":"400897373","full_name":"parafoxia/hikari-intro","owner":"parafoxia","description":"An introduction to hikari, complete with different examples for different command handlers.","archived":false,"fork":false,"pushed_at":"2024-01-10T22:05:20.000Z","size":38,"stargazers_count":19,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-01-10T23:27:26.348Z","etag":null,"topics":["bot","commands","discord","discord-bot","hikari","lightbulb","python","python3","slash","slash-commands","tanjun"],"latest_commit_sha":null,"homepage":"https://discord.gg/ZY2AbQsWXX","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/parafoxia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-28T21:54:19.000Z","updated_at":"2023-12-16T16:05:38.000Z","dependencies_parsed_at":"2023-01-23T00:01:11.726Z","dependency_job_id":null,"html_url":"https://github.com/parafoxia/hikari-intro","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parafoxia%2Fhikari-intro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parafoxia%2Fhikari-intro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parafoxia%2Fhikari-intro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/parafoxia%2Fhikari-intro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/parafoxia","download_url":"https://codeload.github.com/parafoxia/hikari-intro/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227174143,"owners_count":17742399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bot","commands","discord","discord-bot","hikari","lightbulb","python","python3","slash","slash-commands","tanjun"],"created_at":"2024-11-29T17:09:26.258Z","updated_at":"2024-11-29T17:09:26.905Z","avatar_url":"https://github.com/parafoxia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# An intro to hikari\n\nThis repo provides some simple examples to get you started with [hikari](https://github.com/hikari-py/hikari). Contained in this repo are bots designed with the [hikari-arc](https://github.com/hypergonial/hikari-arc), [hikari-crescent](https://github.com/hikari-crescent/hikari-crescent/), [hikari-lightbulb](https://github.com/tandemdude/hikari-lightbulb) and [hikari-tanjun](https://github.com/FasterSpeeding/Tanjun) command handlers.\n\nThis repo only provides examples for slash commands at the moment.\n\n## Installing requirements\n\nYou can install the necessary requirements by doing:\n\n```sh\npip install -r requirements.txt\n```\n\n## Setup\n\nThere is a little bit of setup you need to do before testing the bots, specifically:\n\nYou **must** create a file called `token` in a directory called `secrets` in the root directory of this project, and paste your bot's token in there.\n\n\u003e [!TIP]\n\u003e Be sure to leave **not** add a file extension to the end of this file (e.g. `.txt`), otherwise it will not work.\n\n## Testing the bots\n\n\u003e [!NOTE]\n\u003e The command handlers are sorted alphabetically with no particular preference for one or the other. It is recommended that you give all of them a try before coming to conclusions.\n\n### hikari-arc\n\nThis library was designed from the ground up with modern Python features in mind. It has intuitive functional syntax for creating commands, and an easy to understand [documentation](https://arc.hypergonial.com/). `arc` only supports application commands.\n\nTo run the hikari-arc bot:\n```sh\npython -OO -m arc_bot\n```\n\n### hikari-crescent\n\nThis library is built to keep your project neat and tidy. Commands are created like dataclasses, so the syntax should be familiar. Crescent only supports application commands.\n\nTo run the hikari-crescent bot:\n```sh\npython -OO -m crescent_bot\n```\n\n### hikari-lightbulb\n\nThis library sports a very discord.py-like syntax (when making message commands), making for an easier time migrating for those wishing to switch.\n\nTo run the hikari-lightbulb bot:\n```sh\npython -OO -m lightbulb_bot\n```\n\n### hikari-tanjun\n\nThis library has a syntax far more similar to [click](https://github.com/pallets/click/), a CLI app builder that relies almost entirely on the usage of decorators. It is more powerful than hikari-lightbulb with better support for slash commands and interactions.\n\nTo run the hikari-tanjun bot:\n```sh\npython -OO -m tanjun_bot\n```\n\n## License\n\nThis repo is provided under the [BSD 3-Clause License](https://github.com/parafoxia/hikari-intro/blob/main/LICENSE). This means you can take anything you want from this repo to use in your own bots, though redistributions must retain the license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparafoxia%2Fhikari-intro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparafoxia%2Fhikari-intro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparafoxia%2Fhikari-intro/lists"}