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

Uploaded Source

Built Distribution

hikari-2.0.0.dev63-py3-none-any.whl (331.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hikari-2.0.0.dev63.tar.gz
Algorithm Hash digest
SHA256 9a8bc1a05480feb08a15433187676f10ab823d7e2112907ac9ecb52d9c979663
MD5 4b6281b45d6623a45027e254d37bf46c
BLAKE2b-256 719e6507c6dd9c080cf5c9f94935d2a3ae79e66010876620279b13f888872a70

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for hikari-2.0.0.dev63-py3-none-any.whl
Algorithm Hash digest
SHA256 eb8b8c4b700c1deee03ac26252d492baa7538e0541cecb410999921ee330c8c7
MD5 51bd11a6be97dba66275f6eca38b3a9d
BLAKE2b-256 fe776081aecaf66f4dc25c5051bf79f250e2f88ee7be491624eb3170a3b44e39

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