Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

Metadata

Release files for hikari 2.0.0.dev58

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hikari 2.0.0.dev58
File Size Uploaded
hikari-2.0.0.dev58.tar.gz 239.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hikari 2.0.0.dev58
File Interpreter ABI Platform
hikari-2.0.0.dev58-py3-none-any.whl Python 3 none any Details

Total release size: 563.2 kB

Release files / hikari-2.0.0.dev58.tar.gz

Download URL hikari-2.0.0.dev58.tar.gz
Size 239.3 kB
Tags Source
SHA-256 checksum
How to use checksums
8337ae44d6d9be5d0668284138e198831374e2dbce75366736f6fcaaf9c1d19c
BLAKE2b-256 checksum
How to use checksums
79ab9556c4f2ae79c9d8bcce19ca8ea14a4a9b51b2914dc8c19c7c5f3fae2778
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Release files / hikari-2.0.0.dev58-py3-none-any.whl

Download URL hikari-2.0.0.dev58-py3-none-any.whl
Size 323.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
18d10f45eacddf736fe87dd3e3cfb5a571f9d98de751caaf0670d1829ab94be2
BLAKE2b-256 checksum
How to use checksums
490c2098dc705aa794d392667f430f008cf789abc0c8fe7f3ea6c5dfc04423f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Release history Release notifications | RSS feed

2.6.0

2 release files

2.5.0

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.5

2 release files

2.3.4

2 release files

2.3.3

2 release files

2.3.2

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.0

2 release files

This release

2.0.0.dev58 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page