Examples

Welcome to the examples section of our docs. Basic understanding of python and the usage of disnake’s components is considered pre-knowledge for these examples, along with some familiarity with attrs classes or dataclasses. If this is your first time using disnake-compass, we recommend looking at the Quickstart Guide. The examples aim to show you how some of the features of this extension can be used and implemented.

These examples are also available on our GitHub repository without documentation, and are perfectly runnable as-is. The easiest way of running the examples is:

  1. Ensure uv is installed,

  2. Clone the repository,

  3. Copy .env.example and name it .env,

  4. Enter your bot token in the new .env file,

  5. Run uv run task example <name>.

If you think an example is unclear or an example for a feature is missing, feel free to open a pull request or issue!