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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hikari-2.0.0.dev50-py3-none-any.whl (269.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev50.tar.gz
  • Upload date:
  • Size: 213.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.dev50.tar.gz
Algorithm Hash digest
SHA256 229bd71472129ae0b24090d23dab07b6199c8c01865f9a30d5ee96294f445aa3
MD5 8ad1999b4af416059db54bafe1c5dff2
BLAKE2b-256 1650a2a8229efc0818eca8d7dae2af92e6c5f98208ebd4cc57133143e50d8150

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev50-py3-none-any.whl
  • Upload date:
  • Size: 269.0 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.dev50-py3-none-any.whl
Algorithm Hash digest
SHA256 31d99ea62536e04b6808e83f740d1b26662ce8e0e345756ec75af10056bb3aad
MD5 808c5387b05fbe95b870f8e1384c36ae
BLAKE2b-256 62f91a1e8e73ec55a9c68500861e15259c2871ecf82f1e47cbed6c43bd5b6381

See more details on using hashes here.

Supported by

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