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.dev49.tar.gz (213.0 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.dev49-py3-none-any.whl (268.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev49.tar.gz
  • Upload date:
  • Size: 213.0 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.dev49.tar.gz
Algorithm Hash digest
SHA256 6c061bee4b781fc50b0d2f3d4a3ecbf231b40c2155f3cd0961c9055870d80831
MD5 b1d40b03159394e905cab2e6c6e1f24f
BLAKE2b-256 8ac36b4556fa0ab0f1c917ccae661390d35c1278a6604d638f4a16e1238044fd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev49-py3-none-any.whl
  • Upload date:
  • Size: 268.6 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.dev49-py3-none-any.whl
Algorithm Hash digest
SHA256 bbca902a6dbbd6f7f5ee11ff9002da38cbcaa72bdc458c60c4348c34467c4b15
MD5 f817d53831c3a3608178e0772b4b5a6e
BLAKE2b-256 44eac39888d08feb916655680501c68508c34eab30842c1f48adabcf0aeed92a

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