Skip to main content

A sane Discord API for Python 3 built on asyncio and good intentions

Project description

hikarivers pyvers codecov prs issues black mypy docs



An opinionated, static typed Discord microframework 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="...")

async def ping(event: hikari.MessageCreateEvent) -> None:
    # If a non-bot user sends a message "", respond with "Pong!"

    if not and event.message.content.startswith(""):
        await event.message.reply("Pong!")

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.

async def ping(event):


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 resources

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.

Making your application more efficient

As your application scales, you may need to adjust some things to keep it performing nicely.

Python optimisation flags

CPython and Stackless Python provide two optimisation flags that remove internal safety checks that are useful for development, and change other internal settings in the interpreter.

  • python - no optimisation - this is the default.
  • python -O - first level optimisation - features such as internal assertions will be disabled.
  • python -OO - second level optimisation - more features (including all docstrings) will be removed from the loaded code at runtime.


If you have a C compiler (Microsoft VC++ Redis 14.0 or newer, or a modern copy of GCC/G++, Clang, etc), you can install hikari using pip install -U hikari[speedups]. This will install aiodns, cchardet, and ciso8601, which will provide you with a small performance boost.


If you use Linux, you will get additional performance benefits from using a library called uvloop. This replaces the default asyncio event loop with one that uses libuv internally. You can run pip install uvloop and then amend your script to be something similar to the following example to utilise it in your application:

import os
import hikari

if != "nt":
    import uvloop

bot = hikari.Bot(...)

Compiled extensions

Eventually, we will start providing the option to use compiled components of this library over pure Python ones if it suits your use case. This should also enable further scalability of your application, should PEP 554 -- Multiple Interpreters in the Stdlib be accepted.

Currently, this functionality does not yet exist.

Developing Hikari

If you wish to contribute something, you should first start by cloning the repository.

The first thing you should run is pip install nox to install nox. This handles running predefined tasks and pipelines.

To initialize a development environment and install everything you need, simply run nox -s init. This will create a venv and install everything you need in it to get started.

Once this is complete, you can run nox without any arguments to ensure everything builds and is correct.

Where can I start?

Check out the issues tab on GitHub. If you are nervous, look for issues marked as good-first-issue-badge for something easy to start with!


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

hikari-2.0.0.dev75.tar.gz (264.8 kB view hashes)

Uploaded Source

Built Distribution

hikari-2.0.0.dev75-py3-none-any.whl (346.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page