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 pre-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.dev48.tar.gz (212.6 kB view details)

Uploaded Source

Built Distribution

hikari-2.0.0.dev48-py3-none-any.whl (268.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev48.tar.gz
  • Upload date:
  • Size: 212.6 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.0 CPython/3.8.5

File hashes

Hashes for hikari-2.0.0.dev48.tar.gz
Algorithm Hash digest
SHA256 1e9fbd828fe0065e47692abc4f173a7c0f322a860953d0475afc29a3b4924788
MD5 2acb0d5703c976ca2ddd9aaffd412bb5
BLAKE2b-256 1542a4a5a0e54d034e8835ae444fb11e674eb71c68d4cd3d32da5fabcd575189

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev48-py3-none-any.whl
  • Upload date:
  • Size: 268.3 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.0 CPython/3.8.5

File hashes

Hashes for hikari-2.0.0.dev48-py3-none-any.whl
Algorithm Hash digest
SHA256 1b063395a33bb231305c3fa6e2c117c912401227250bdf1eb037bb19785511c4
MD5 547d6b9b7843ca66cac7ec87530b409d
BLAKE2b-256 36b8a79d4f696b5d9913236c78b392d071f41034f0b59b99ed731cbd623aef12

See more details on using hashes here.

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