Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.4 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.4 KB

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 and, more specifically, the usage guide.

Support

Hikari's support guild provides for support for Yuyo.

Contributing

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