This release is a pre-release and may not be stable for production use.
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
from hikari.events.message import MessageCreateEvent
bot = hikari.Bot(token="...")
@bot.listen(MessageCreateEvent)
async def ping(event):
# 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()
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
Moar poweeeerrrr
If you wish to get the most out of your bot, you should opt-in to installing the speedups extensions.
python -m pip install hikari[speedups] -U --pre
This may take a little longer to install, but will replace several dependencies with much faster alternatives, including:
aiodns- Asynchronous DNS lookups usingpycares(libcaresPython bindings).cchardet- a compiled C implementation of thechardetmodule. Claims to handle almost 1468 calls per second in a benchmark, compared to 0.35 calls per second from the defaultchardetmodule, which is around 4193x faster.*
* cchardet v2.1.6 Python 3.6.1, Intel(R) Core(TM) i5-4690 CPU @ 3.50GHz,
16GB 1.6GHz DDR3, Ubuntu 16.04 AMD64.
Note that you may find you need to install a C compiler on your machine to make use of these extensions.
What does hikari aim to do?
- Provide 100% documentation for the entire library. Build your application bottom-up or top-down with comprehensive documentation as standard. Currently more than 45% of this codebase consists of documentation.
- Ensure all components are reusable. Most people want a basic framework for writing a bot, and hikari will provide that. However, if you decide on a bespoke solution using custom components, such as a Redis state cache, or a system where all events get put on a message queue, then hikari provides the conduit to make that happen.
- Automate testing as much as possible. You don't want to introduce bugs into your bot with version updates, and neither do we. hikari aims for 100% test coverage as standard. This significantly reduces the amount of bugs and broken features that appear in library releases -- something most Python Discord libraries cannot provide any guarantee of.
- Small improvements. Regularly. Discord is known for pushing sudden changes to their public APIs with little or no warning. When this happens, you want a fix, and quickly. You do not want to wait for weeks for a usable solution to be released. hikari is developed using a fully automated CI pipeline with extensive quality assurance. This enables bugfixes and new features to be shipped within 30 minutes of coding them, not 30 days.
What does hikari currently support?
Library features
hikari has been designed with the best practises at heart to allow developers to freely contribute and help the library grow. This is achieved in multiple ways.
- Modular, reusable components.
- Extensive documentation.
- Support for using type hints to infer event types.
- Minimal dependencies.
- Rapidly evolving codebase.
- Full unit test suite.
Network level components
The heart of any application that uses Discord is the network layer. hikari exposes all of these components with full documentation and with the ability to reuse them in as many ways as you can think of.
Most mainstream Python Discord APIs lack one or more of the following features. hikari aims to implement each feature as part of the design, rather than an additional component. This enables you to utilize these components as a black box where necessary.
- Low level REST API implementation.
- Low level gateway websocket shard implementation.
- Rate limiting that complies with the
X-RateLimit-Bucketheader properly. - Gateway websocket ratelimiting (prevents your websocket getting completely invalidated).
- Intents.
- Proxy support for websockets and REST API.
- File IO that doesn't block you.
- Fluent Pythonic API that does not limit your creativity.
High level components
- Stateless, object-oriented bot API. Serve thousands of servers on little memory.
- Sensible, type-safe event dispatching system that is reactive to type annotations, and supports PEP-563 without broken hacks and bodges.
- Models that extend the format provided by Discord, not fight against it. Working as close to the original format of information provided by Discord as possible ensures that minimal changes are required when a breaking API design is introduced. This reduces the amount of stuff you need to fix in your applications as a result.
- Standalone REST client. Not writing a bot, but need to use the API anyway? Simply
initialize a
hikari.RESTClientand away you go.
Stuff coming soon
- Optional, optimised C implementations of internals to give large applications a well-deserved performance boost.
Planned extension modules for the future
- Command framework (make commands and groups with the flick of a wrist).
- Optional dependency injection tools (declare what components you want in your application, and where you want them. Let hikari work out how to put it together!)
- Full voice transcoding support, natively in your application. Do not rely on invoking ffmpeg in a subprocess ever again!
Getting started
This section is still very bare, and we are still actively writing this framework every day. Why not pop in and say hi? More comprehensive tutorials will be provided soon!
1 maintainer
Release files for hikari 2.0.0.dev11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hikari-2.0.0.dev11.tar.gz | 169.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hikari-2.0.0.dev11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 392.1 kB
Release files / hikari-2.0.0.dev11.tar.gz
| Download URL | hikari-2.0.0.dev11.tar.gz |
|---|---|
| Size | 169.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71db4b079f220fdebbaeea70fdb13b5c7a7f5c6852a231224b7a98363070a152
|
|
BLAKE2b-256 checksum How to use checksums |
23bab5e2645a38c8bf71eb9e5c17ef0613100ee0863c79e3aa8ff9fd8ba30bf0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
|
Release files / hikari-2.0.0.dev11-py3-none-any.whl
| Download URL | hikari-2.0.0.dev11-py3-none-any.whl |
|---|---|
| Size | 222.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80eecef9ec7500af1c09fe16907ae162fa882f0c60f4882fd09a4d39e7f8c0dc
|
|
BLAKE2b-256 checksum How to use checksums |
36d82cf5a2678ce8b182d1536affe423dec95048b2b3f07bf7106e1033ca2e36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
|
