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.dev64.tar.gz (243.3 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.dev64-py3-none-any.whl (324.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev64.tar.gz
  • Upload date:
  • Size: 243.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.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for hikari-2.0.0.dev64.tar.gz
Algorithm Hash digest
SHA256 ba8a572bff872665db59c0f7b9918aa0961c1105448c4950ff63e9d9914c792e
MD5 ea186c252fc59a8dc08e5d8304b44f9a
BLAKE2b-256 8651ff95d1351b3e7bc5c6570dc74938169a79c8e5ee0cc33c731dc6b02de10d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev64-py3-none-any.whl
  • Upload date:
  • Size: 324.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.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for hikari-2.0.0.dev64-py3-none-any.whl
Algorithm Hash digest
SHA256 39b9d6fd509246c46525500bb18c91a39eeb6b26f99375a5625065b46ace93b7
MD5 3259d436975a2a0dbe2b6dbbff54063d
BLAKE2b-256 e6d975604bc076d83ebd6d4aa6c4e5a08e76ea5d4a45f897d705458eb576bd1c

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