https://github.com/fasterspeeding/tanjun

A flexible command framework designed to extend the Hikari experience
https://github.com/fasterspeeding/tanjun

dependency-injection discord discord-api discord-bot discord-bot-framework hacktoberfest hikari slash-commands tanjun

Last synced: 3 days ago
JSON representation

A flexible command framework designed to extend the Hikari experience

• Host: GitHub
• URL: https://github.com/fasterspeeding/tanjun
• Owner: FasterSpeeding
• License: bsd-3-clause
• Created: 2020-11-17T23:59:02.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-18T10:27:22.000Z (12 days ago)
• Last Synced: 2025-01-20T12:03:01.789Z (10 days 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: 60.3 MB
• Stars: 93
• Watchers: 1
• Forks: 12
• Open Issues: 25
• 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

[Hikari's support guild](https://discord.gg/hikari) provides for support for Tanjun.

# 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).