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

Discord

hikari

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="...")


@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 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 bot.py - no optimisation - this is the default.
  • python -O bot.py - first level optimisation - features such as internal assertions will be disabled.
  • python -OO bot.py - second level optimisation - more features (including all docstrings) will be removed from the loaded code at runtime.

hikari[speedups]

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.

uvloop

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 os.name != "nt":
    import uvloop
    uvloop.install()

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!

good-first-issues

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.dev78.tar.gz (271.0 kB view details)

Uploaded Source

Built Distribution

hikari-2.0.0.dev78-py3-none-any.whl (351.7 kB view details)

Uploaded Python 3

File details

Details for the file hikari-2.0.0.dev78.tar.gz.

File metadata

  • Download URL: hikari-2.0.0.dev78.tar.gz
  • Upload date:
  • Size: 271.0 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.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for hikari-2.0.0.dev78.tar.gz
Algorithm Hash digest
SHA256 06a847ae2f06d8e98b06bc8938fe4e45eed61a9c17f566955f8d45e56c47cfab
MD5 f9edff6939f2d522d83bf6540a47d9e6
BLAKE2b-256 dfda4067eec5e8863500675591008e255db1ca1a2b83750cc838bf23f39a6acf

See more details on using hashes here.

File details

Details for the file hikari-2.0.0.dev78-py3-none-any.whl.

File metadata

  • Download URL: hikari-2.0.0.dev78-py3-none-any.whl
  • Upload date:
  • Size: 351.7 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.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for hikari-2.0.0.dev78-py3-none-any.whl
Algorithm Hash digest
SHA256 52b139f47b22d0d0a64cb83e874487c93a4f278e53ab3aab8fc211942c7a3f19
MD5 759f3a69f50f07c0854986f944db388c
BLAKE2b-256 7a4783a3799a9132385dba81ad4dadefc7f1c4f48143b882c3a1fbe26e7da500

See more details on using hashes here.

Supported by

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