This release is a pre-release and may not be stable for production use.
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
By default, a database is scaffolded alongside your bot. Pass --no-database to skip
it, and add one later with grace generate database.
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 MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file grace_framework-1.5.0a0.tar.gz.
File metadata
- Download URL: grace_framework-1.5.0a0.tar.gz
- Upload date:
- Size: 61.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3496546c5c2fef6107797a3e08462a943c2e319e7f2f5b9f36bb37db92a829ac
|
|
| MD5 |
91643aade45b3c6d6d248fcdea4adbad
|
|
| BLAKE2b-256 |
ffb766fc697753c50e6a8165c9776b4ca67c7abc896de95c215ac39b0b2c98b7
|
Provenance
The following attestation bundles were made for grace_framework-1.5.0a0.tar.gz:
Publisher:
publish.yml on Code-Society-Lab/grace-framework
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
grace_framework-1.5.0a0.tar.gz -
Subject digest:
3496546c5c2fef6107797a3e08462a943c2e319e7f2f5b9f36bb37db92a829ac - Sigstore transparency entry: 2298732292
- Sigstore integration time:
-
Permalink:
Code-Society-Lab/grace-framework@06ed1cc9ca2947d0151ba2ddaf4e16af6215f397 -
Branch / Tag:
refs/tags/1.5.0-alpha - Owner: https://github.com/Code-Society-Lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@06ed1cc9ca2947d0151ba2ddaf4e16af6215f397 -
Trigger Event:
release
-
Statement type:
File details
Details for the file grace_framework-1.5.0a0-py3-none-any.whl.
File metadata
- Download URL: grace_framework-1.5.0a0-py3-none-any.whl
- Upload date:
- Size: 38.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e32e75834e7221a94ea87946f76920db795bba5f16a51f26d84e90168f083f09
|
|
| MD5 |
b80b6e4a535239d72bbd1745dbc31551
|
|
| BLAKE2b-256 |
7348c605f1f30aa8587ec16bc5937167b33d4357c91cc701c14d7474e2af32f5
|
Provenance
The following attestation bundles were made for grace_framework-1.5.0a0-py3-none-any.whl:
Publisher:
publish.yml on Code-Society-Lab/grace-framework
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
grace_framework-1.5.0a0-py3-none-any.whl -
Subject digest:
e32e75834e7221a94ea87946f76920db795bba5f16a51f26d84e90168f083f09 - Sigstore transparency entry: 2298732298
- Sigstore integration time:
-
Permalink:
Code-Society-Lab/grace-framework@06ed1cc9ca2947d0151ba2ddaf4e16af6215f397 -
Branch / Tag:
refs/tags/1.5.0-alpha - Owner: https://github.com/Code-Society-Lab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@06ed1cc9ca2947d0151ba2ddaf4e16af6215f397 -
Trigger Event:
release
-
Statement type:
