📘 API Documentation

The documentation for the goldy bot v5 framework programming api.

• 📀CLI
• 🧡 Goldy Core
• ⚙ Utils

Logging

Config

Errors

exception GoldyBot.errors.GoldyBotError(message: str, logger: Logger | None = None)

Bases: Exception

Raises whenever there’s a known error in goldy bot.

exception GoldyBot.errors.InvalidParameter(command: Command, invalid_param: str)

Bases: GoldyBotError

Raises whenever there is an invalid parameter in a command. Normally occurs when you have uppercase characters in a command argument.

exception GoldyBot.errors.InvalidTypeInMethod(message)

Bases: GoldyBotError

Raises whenever there is an invalid typing being inputted. Is normally is found in GoldyBot methods that default to None in it’s arguments.

exception GoldyBot.errors.NotSupportedYetForSlash(operation, logger: Logger | None = None)

Bases: GoldyBotError

Raises whenever there is an operation that isn’t supported just yet for slash commands.

Info

GoldyBot.info.VER = 5.0

Just the version number as an integer. E.g 5.0.

GoldyBot.info.VERSION = '5.0dev13'

Goldy Bot version string. E.g 5.0alpha8.

Paths

class GoldyBot.paths.Paths

Bases: object

Class containing important paths like template files and stuff.

ASSETS = '/home/runner/work/goldy-bot-framework/goldy-bot-framework/GoldyBot/assets'

GOLDY_BOT_ROOT = PosixPath('/home/runner/work/goldy-bot-framework/goldy-bot-framework/GoldyBot')

GOLDY_JSON_TEMPLATE = '/home/runner/work/goldy-bot-framework/goldy-bot-framework/GoldyBot/assets/goldy.json'

INTERNAL_EXTENSIONS = '/home/runner/work/goldy-bot-framework/goldy-bot-framework/GoldyBot/internal_extensions'

RUN_SCRIPT_TEMPLATE = '/home/runner/work/goldy-bot-framework/goldy-bot-framework/GoldyBot/assets/run.py'

TOKEN_ENV_TEMPLATE = '/home/runner/work/goldy-bot-framework/goldy-bot-framework/GoldyBot/assets/token.env'