https://github.com/cursed-solutions/tanjun
A flexible command framework designed to extend the Hikari experience
https://github.com/cursed-solutions/tanjun
dependency-injection discord discord-api discord-bot discord-bot-framework hacktoberfest hikari slash-commands tanjun
Last synced: about 2 months ago
JSON representation
A flexible command framework designed to extend the Hikari experience
- Host: GitHub
- URL: https://github.com/cursed-solutions/tanjun
- Owner: Cursed-Solutions
- License: bsd-3-clause
- Created: 2020-11-17T23:59:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T09:55:53.000Z (2 months ago)
- Last Synced: 2025-03-31T01:36:27.641Z (about 2 months ago)
- Topics: dependency-injection, discord, discord-api, discord-bot, discord-bot-framework, hacktoberfest, hikari, slash-commands, tanjun
- Language: Python
- Homepage: https://tanjun.cursed.solutions/usage/
- Size: 62.1 MB
- Stars: 90
- Watchers: 1
- Forks: 12
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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.11 or above environment.
```
python -m pip install -U hikari-tanjun
```
# Getting started
For an overview on using Hikari for creating bots see [HG](https://hg.cursed.solutions/).
For a guide on Tanjun's main features see the [usage guide](https://tanjun.cursed.solutions/usage/).
There's also [Tanjun's general documentation](https://tanjun.cursed.solutions/), and some
[tutorials and articles](https://patchwork.systems/programming/hikari-discord-bot/index.html).
# Community Resources
* [Tan-chan](https://tanchan.cursed.solutions/) 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](https://sake.cursed.solutions/) \>=v1.0.1a1 (exposed by
[sake.redis.ResourceClient.add_to_tanjun][]).
# Support
Go to the [support server](https://discord.gg/bZ7BrYJ63g) for support.
# Contributing
Before contributing you should read through the
[contributing guidelines](https://github.com/FasterSpeeding/Tanjun/blob/master/CONTRIBUTING.md) and
the [code of conduct](https://github.com/FasterSpeeding/Tanjun/blob/master/CODE_OF_CONDUCT.md).