https://github.com/fasterspeeding/yuyo
A collection of utility classes and functions designed to expand Hikari.
https://github.com/fasterspeeding/yuyo
bot discord discord-api hacktoberfest hikari
Last synced: 5 months ago
JSON representation
A collection of utility classes and functions designed to expand Hikari.
- Host: GitHub
- URL: https://github.com/fasterspeeding/yuyo
- Owner: FasterSpeeding
- License: bsd-3-clause
- Created: 2020-11-09T02:45:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T12:17:43.000Z (about 1 year ago)
- Last Synced: 2024-05-01T15:19:23.940Z (about 1 year ago)
- Topics: bot, discord, discord-api, hacktoberfest, hikari
- Language: Python
- Homepage: https://yuyo.cursed.solutions/
- Size: 16 MB
- Stars: 20
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
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
# Yuyo
A collection of utility classes and functions designed to expand Hikari.
# Instillation
You can install yuyo from PyPI using the following command.
```
python -m pip install -U hikari-yuyo
```
The following feature flags ensure feature-specific optional dependencies are also installed:
* `hikari-yuyo[asgi]` ensures the dependencies required to run the Asgi RESTBot adapter.
* `hikari-yuyo[cli]` ensures the dependencies required to use the provided CLI commands are
installed.
* `hikari-yuyo[sake]` can be used to ensure the installed Sake version is compatible with
Yuyo's functionality which uses Sake. You should still have a Sake version pinned in your
own requirements as this just provides an accepted range for the dependency.
* `hikari-yuyo[tanjun]` can be used to ensure the installed Tanjun version is compatible with
Yuyo's Tanjun support (i.e. the `from_tanjun`) class methods.
# Quick Usage.
For usage see the the [documentation](https://yuyo.cursed.solutions/) and, more
specifically, the [usage guide](https://yuyo.cursed.solutions/usage/).
# Support
[Hikari's support guild](https://discord.gg/hikari) provides for support for Yuyo.
# Contributing
Before contributing you should read through the
[contributing guidelines](https://github.com/FasterSpeeding/Yuyo/blob/master/CONTRIBUTING.md) and
the [code of conduct](https://github.com/FasterSpeeding/Yuyo/blob/master/CODE_OF_CONDUCT.md).