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

Uploaded Source

Built Distribution

hikari-2.0.0.dev53-py3-none-any.whl (285.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev53.tar.gz
  • Upload date:
  • Size: 221.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/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for hikari-2.0.0.dev53.tar.gz
Algorithm Hash digest
SHA256 a8fc4ad38ac35e0b0d0694bbce952b029e9777ead3ae3a4cea19cb020889c6bb
MD5 a4625e448fcf23f2f8f23ed64c427835
BLAKE2b-256 3b280084617e31e7a6e03af066daf44201fb193e0dd57b3b34b8096ef7cd7eb1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hikari-2.0.0.dev53-py3-none-any.whl
  • Upload date:
  • Size: 285.7 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.dev53-py3-none-any.whl
Algorithm Hash digest
SHA256 4bc7eaed9d5fa74ae82eae908366bacbdaa5c834b7571bfb21bc9c53cfcd0f89
MD5 137188e71c57499517c75f1a537bf025
BLAKE2b-256 55cc70579c947f0e5bbba10ea98cba23577e52d6a011d4fdf1d323b4db804f9f

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