Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

hikari

An opinionated Discord API for Python 3 and asyncio.

THIS API IS CURRENTLY IN A PRE-ALPHA STAGE, SO NEW VERSIONS WILL CONTAIN BREAKING CHANGES WITHOUT A MINOR VERSION INCREMENTATION. ALL FEATURES ARE PROVISIONAL AND CAN CHANGE AT ANY TIME UNTIL THIS API IS IN A USABLE STATE FOR A FULL FIRST RELEASE.

Please VISIT MY DISCORD if you wish to receive progress updates or help out, any help and contribution is more than welcome :-)

If you wish to explore the code in an online interactive viewer, you can use Sourcegraph on master and staging too!

What is this API?

A base Python Discord API framework for CPython 3.8 Designed for ease of use, customization, and sane defaults.

This API is designed to provide the pure-python interface to the RESTful Discord API and the Gateway. This will provide a set of basic models and abstractions that can be used to build a basic Discord bot in Python with asyncio in a logical, idiomatic, Pythonic, concise way.

Other APIs may exist that are faster, use less memory, or are smaller. I wont dispute that. The aim of this library is to provide a solid and consistent interface that can be relied upon by the end user, and to provide regular updates that are able to be opted into.

I also aim to provide as much automated test coverage as possible. I want to be able to immediately prove that a function does what is expected of it to provide hard evidence that a build is not fundamentally broken before deploying it.

The final aim is for maintainability. This API attempts to be as documented and expandable as possible internally. If something isn't right and you have some understanding of Python, hopefully you should be able to pick it up and tweak it to solve your use case, rather than fighting inflexible internal abstractions that hide the information you need.

What is this API not?

This API is not for people using anything older than CPython 3.8.

It currently is not able to provide voice functionality. Again, this may be added in the future.

FAQ

Contributing to Hikari

View the contributing guide!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hikari-1.0.1.dev39.tar.gz (162.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hikari-1.0.1.dev39-py3-none-any.whl (201.2 kB view details)

Uploaded Python 3

File details

Details for the file hikari-1.0.1.dev39.tar.gz.

File metadata

  • Download URL: hikari-1.0.1.dev39.tar.gz
  • Upload date:
  • Size: 162.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for hikari-1.0.1.dev39.tar.gz
Algorithm Hash digest
SHA256 8db11e1ddbd039ab2e214278984d451fa1cd9625d97651efe523ae556a2f1668
MD5 8c31f3fedebcbc93f46ee9e0089797f3
BLAKE2b-256 801eba208240fa440826e5a0a45406c89f8d0bd54de358330589c27dfdd63d5d

See more details on using hashes here.

File details

Details for the file hikari-1.0.1.dev39-py3-none-any.whl.

File metadata

  • Download URL: hikari-1.0.1.dev39-py3-none-any.whl
  • Upload date:
  • Size: 201.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for hikari-1.0.1.dev39-py3-none-any.whl
Algorithm Hash digest
SHA256 61c88f23f8af0bb324e360e6e3c22df9ab1ff2dd1166544f28f82f2c98228455
MD5 13e5c29ce86a56076fa07bb47e0b4126
BLAKE2b-256 655ae3eb448a9e3af6fde02f37d84ed793f1ee4e43166c86a34c1589a5bbe942

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page