Skip to main content

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

hikari-2.0.0.dev58.tar.gz (239.3 kB view details)

Uploaded Source

Built Distribution

hikari-2.0.0.dev58-py3-none-any.whl (323.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hikari-2.0.0.dev58.tar.gz
Algorithm Hash digest
SHA256 8337ae44d6d9be5d0668284138e198831374e2dbce75366736f6fcaaf9c1d19c
MD5 d9710c7430c442a7509b89ea9b865ce9
BLAKE2b-256 79ab9556c4f2ae79c9d8bcce19ca8ea14a4a9b51b2914dc8c19c7c5f3fae2778

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hikari-2.0.0.dev58-py3-none-any.whl
Algorithm Hash digest
SHA256 18d10f45eacddf736fe87dd3e3cfb5a571f9d98de751caaf0670d1829ab94be2
MD5 f901404415cb38b0e69b37d7d0aa3c1e
BLAKE2b-256 490c2098dc705aa794d392667f430f008cf789abc0c8fe7f3ea6c5dfc04423f2

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