grace-framework 0.10.6a0

Extensible Discord bot framework based on Discord.py

Grace Framework

Build powerful Discord bots, without the boilerplate.

What is Grace Framework

Grace Framework is an opinionated, extensible Discord bot framework built on top of discord.py. It comes with a various tools designed to help you rapidly build scalable, feature-rich Discord bots with minimal boilerplate.

Key features

• Quick to start: Generate a full-featured bot in seconds
• Modular Architecture: Clean separation of features via extensions
• Database Integration: Easily connect your bot to a persistent backend
• Built-in Generators: Create extensions, models and more with a single command

Inspiration

Grace Framework was inspired by the evolution of our community discord bot, Grace, that evolved, gaining support for modular extensions, database integrations, and rapid feature development — it began to resemble a standalone framework. Recognizing its potential, we decided to extracted its architecture into Grace Framework, making its ease-of-use and flexibility available to developers everywhere.

Getting Started

1- Install the package

requirements

• Python 3.10 or higher
• SQLite (or Postgresql, MySQL & MariaDB, Oracle, and MS-SQL)

$ pip install grace-framework

To install the development version:

$ git clone https://github.com/Code-Society-Lab/grace-framework.git
$ cd grace-framework
$ pip install -e .

Note: It is recommended to use a virtual environment when installing python packages.

2- Generate a new bot

$ grace new my-awesome-bot
$ cd my-awesome-bot

3- Set your bot token

Edit the .env in the project directory and set DISCORD_TOKEN.

DISCORD_TOKEN=YOUR TOKEN

4- Run your bot

$ grace run

5- Start building!

Check out the official wiki for guides, architecture, and API reference.

Contributing

We welcome everyone to contribute!

Whether it's fixing bugs, suggesting features, or improving the docs - every bit helps.

• Submit an issue
• Open a pull request
• Or just hop into our Discord community and say hi!

If you intend to contribute, please read the CONTRIBUTING.md first. Additionally, every contributor is expected to follow the code of conduct.

License

Grace Framework is released under GPL-3.0