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

Uploaded Source

Built Distribution

hikari-2.0.0.dev41-py3-none-any.whl (257.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev41.tar.gz
  • Upload date:
  • Size: 194.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for hikari-2.0.0.dev41.tar.gz
Algorithm Hash digest
SHA256 34fb751504f7c68ad4369407094d52234b5a7f07ec56d0ec558c7742882745ad
MD5 0d263ad58ea8ee06a83b0dc1e5c41b25
BLAKE2b-256 05b29c314af8296525525a537b484139003c84d41754c07262ab6044e4edabe2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev41-py3-none-any.whl
  • Upload date:
  • Size: 257.5 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/47.1.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for hikari-2.0.0.dev41-py3-none-any.whl
Algorithm Hash digest
SHA256 1479342ea3b833d475ce043b91962b5b486f40f6e6678ffb2f2e64860b0532f4
MD5 c3d54e613555d2a16a8b7622eec62768
BLAKE2b-256 80300da290c8789b5a4699b14afeb9322706920af262ead64440b34c10ce954c

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