A sane Discord API for Python 3 built on asyncio and good intentions
Project description
Note: this API is still under active daily development, and is in a alpha stage. If you are looking to give feedback, or want to help us out, then feel free to join our Discord server and chat to us. Any help is greatly appreciated, no matter what your experience level may be! :-)
hikari
An opinionated, static typed Discord API for Python3 and asyncio.
Built on good intentions and the hope that it will be extendable and reusable, rather than an obstacle for future development.
import hikari
bot = hikari.Bot(token="...")
@bot.listen()
async def ping(event: hikari.MessageCreateEvent) -> None:
# If a non-bot user sends a message "hk.ping", respond with "Pong!"
if not event.message.author.is_bot and event.message.content.startswith("hk.ping"):
await event.message.reply("Pong!")
bot.run()
Events are determined by the type annotation on the event parameter, or
alternatively as a type passed to the @bot.listen()
decorator, if you do not
want to use type hints.
@bot.listen(hikari.MessageCreateEvent)
async def ping(event):
...
Installation
Install hikari from PyPI with the following command:
python -m pip install hikari -U --pre
# Windows users may need to run this instead...
py -3 -m pip install hikari -U --pre
Additional libraries
You may wish to use a command framework on top of Hikari so that you can start writing a bot quickly without implementing your own command handler.
Hikari does not include a command framework by default, so you will want to pick a third party library to do it.
lightbulb
- a simple and easy to use command framework for Hikari.
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
File details
Details for the file hikari-2.0.0.dev69.tar.gz
.
File metadata
- Download URL: hikari-2.0.0.dev69.tar.gz
- Upload date:
- Size: 241.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3f57c6dcba971f2341ca65b694fd12d4801faada3b07b79b8c54149ee648d4c |
|
MD5 | 097f30c97f9ee7edecae8c9652b6f339 |
|
BLAKE2b-256 | 39e0dfad9542ff3a9011fb196f66b7863074458350d0c19518a704c4cac23937 |
File details
Details for the file hikari-2.0.0.dev69-py3-none-any.whl
.
File metadata
- Download URL: hikari-2.0.0.dev69-py3-none-any.whl
- Upload date:
- Size: 324.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7137dff31218b03f8f8ac5ed1e8d9730cc9a725b64709625559d56e7b2d4ccbe |
|
MD5 | 3726ecf8930f6e15e59b3e003ae69830 |
|
BLAKE2b-256 | c68128c3de91cd6085a0f21441272447ced1679e8db6344eb03d66c1a1976ae0 |