/Tanjun

A flexible command framework designed to extend the Hikari experience

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Tanjun Library

A flexible command framework designed to extend Hikari.

Installation

You can install Tanjun from PyPI using the following command in any Python 3.9 or above environment.

python -m pip install -U hikari-tanjun

Getting started

For an overview on using Hikari for creating bots see HG.

For a guide on Tanjun's main features see the usage guide.

There's also Tanjun's general documentation, and some tutorials and articles.

Community Resources

  • Tan-chan is a general utility library for Tanjun. It includes a command annotation parsing extension which parses docstrings to get the descriptions of slash commands and their options.
  • Redis based implementations of the async cache dependency can be found in hikari-sake >=v1.0.1a1 (exposed by [sake.redis.ResourceClient.add_to_tanjun][]).

Support

Hikari's support guild provides for support for Tanjun.

Contributing

Before contributing you should read through the contributing guidelines and the code of conduct.