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.dev44.tar.gz (198.4 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.dev44-py3-none-any.whl (255.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev44.tar.gz
  • Upload date:
  • Size: 198.4 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.4

File hashes

Hashes for hikari-2.0.0.dev44.tar.gz
Algorithm Hash digest
SHA256 0abec93f825466ca05eebc83d8e8fec641b6f90128e4fc5d376734ab6105cdd8
MD5 9e4e861b03689c44a913503165c00001
BLAKE2b-256 98cc159799a2f62d50723507cc8072a8e5abc6e78a8967c6a2d18d7bdb9b9608

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev44-py3-none-any.whl
  • Upload date:
  • Size: 255.2 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.4

File hashes

Hashes for hikari-2.0.0.dev44-py3-none-any.whl
Algorithm Hash digest
SHA256 abbdf13dc1e05e2c0fd496a609906a9e6f4035ed94652eada4bab3fd1cca8bcc
MD5 d096c7d791f9eccb1afe7d9a5a2aeab3
BLAKE2b-256 3e9af1c199825c3a5923c603224d5587e78701724aebbe8a586af343ca2e8142

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