A command handler for hikari with a focus on type-safety and correctness.
Installation
To install arc, run the following command:
pip install -U hikari-arc
To check if arc has successfully installed or not, run the following:
python3 -m arc
# On Windows you may need to run:
py -m arc
[!NOTE]
hikari-arcrequires a Python version of at least 3.11.
If you're just getting started, you may also use the template repository to get started with.
Basic Usage
import hikari
import arc
bot = hikari.GatewayBot("TOKEN") # or hikari.RESTBot
client = arc.GatewayClient(bot) # or arc.RESTClient
@client.include
@arc.slash_command("hi", "Say hi!")
async def ping(
ctx: arc.GatewayContext,
user: arc.Option[hikari.User, arc.UserParams("The user to say hi to.")]
) -> None:
await ctx.respond(f"Hey {user.mention}!")
bot.run()
To get started with arc, see the documentation, or the examples.
Issues and support
For general usage help or questions, see the hikari discord, if you have found a bug or have a feature request, feel free to open an issue!
Contributing
See Contributing.
Acknowledgements
arc is in large part a combination of all the parts I like in other command handlers, with my own spin on it. The following projects have inspired me and aided me greatly in the design of this library:
hikari-lightbulb- The library initially started as a reimagination of lightbulb, it inherits a similar project structure and terminology.Tanjun- For the idea of usingtyping.Annotatedand dependency injection in a command handler.arcalso uses the same dependency injection library,Alluka, under the hood.hikari-crescentThe design of hooks is largely inspired bycrescent.FastAPI- Some design ideas and most of the documentation configuration derives fromFastAPI.- The
arclogo was made by @PythonTryHard.
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_arc-2.3.2.tar.gz.
File metadata
- Download URL: hikari_arc-2.3.2.tar.gz
- Upload date:
- Size: 1.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","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 |
e6770b6c9355c3236deb47af1f717b395a20f465f68926b0c931c56a86fd2212
|
|
| MD5 |
fdf5b202dcf852d52fa5578ccc3f9d83
|
|
| BLAKE2b-256 |
56b44ac5d1a96e3ac614cd418a53e3ec74a25de94a1ded299d1e270522bcfad0
|
File details
Details for the file hikari_arc-2.3.2-py3-none-any.whl.
File metadata
- Download URL: hikari_arc-2.3.2-py3-none-any.whl
- Upload date:
- Size: 127.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","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 |
fe5561e55e57b499dd1712e89b0eb6ac4c35598beefc77602a2c0c8fbf194eb0
|
|
| MD5 |
96bfc3078659afa8d298b7ce188f721d
|
|
| BLAKE2b-256 |
f6f06897e549a2702ef0d5c32e5ccbc923bc20eb5f0ffe0fbf667876866db650
|
