https://github.com/code-society-lab/grace
The official Code Society Discord bot
https://github.com/code-society-lab/grace
discord discord-bot fun learning learning-by-doing open-source python python3
Last synced: 19 days ago
JSON representation
The official Code Society Discord bot
- Host: GitHub
- URL: https://github.com/code-society-lab/grace
- Owner: Code-Society-Lab
- License: gpl-3.0
- Created: 2021-06-01T20:28:50.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-15T22:32:54.000Z (4 months ago)
- Last Synced: 2025-11-16T00:20:22.916Z (4 months ago)
- Topics: discord, discord-bot, fun, learning, learning-by-doing, open-source, python, python3
- Language: Python
- Homepage:
- Size: 979 KB
- Stars: 19
- Watchers: 6
- Forks: 14
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: license.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Grace
[](https://discord.gg/code-society-823178343943897088)
[](https://github.com/Code-Society-Lab/grace/actions/workflows/grace.yml)
[](https://github.com/code-society-lab/grace/commits/main)
Grace is the official Code Society discord bot. The goal is to give our members the opportunity to participate in the
development of the server's bot and contribute to a team project while also improving it.
---
## Installation
Installing Grace is fairly simple. You can do it in three short step.
0. [Install Python and dependencies](#0-install-python-and-dependencies)
1. [Set up your app and token](#1-set-up-your-app-and-token)
2. [Start the bot](#2-start-the-bot)
### 0. Python and Dependencies
Install [Python](https://www.python.org/downloads/). Python 3.10 or higher is required.
> [!NOTE]
> We highly recommend that you set up a virtual environment to work on Grace.
> https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/
In the `grace` directory, open a terminal (Linus/MacOS) or cmd (Windows) and execute `pip install -e .`
(recommended for development) or `pip install .`.
### 1. Set up your App and Token
If you did not already do it, [create](https://discord.com/developers/docs/getting-started#creating-an-app) your Discord
bot. Then, create a file called `.env` in the project directory, open it and add
`DISCORD_TOKEN=`. (Replace by your discord token).
> [!CAUTION]
> Do not share that file nor the information inside with anyone.
### 2. Run the Bot
The last part is to execute the bot. Execute `grace run` to run Grace in development mode. The rest
of the installation should complete itself and start the bot.
> [!NOTE]
> If the grace command is unrecognized, be sure that you installed the bot properly.
## Script Usage
- **Bot Command(s)**:
- `grace run` : Starts the bot (`ctrl+c` to stop)
- **Database Command(s)**:
- `grace db create` : Creates the database
- `grace db drop` : Deletes the database
- `grace db up` : Upgrade to latest migration
- `grace db down` : Downgrade to previous migration
- `grace db seed` : Seeds the tables
Run `grace --help` for more information.
---
## Advance configurations
For advance configurations, visit the [wiki](https://github.com/Code-Society-Lab/grace/wiki)
## Contribution
As mentioned in the description, we invite everyone to participate in the development of the bot. You can contribute to the project by simply opening an issue, by improving some current features or even by adding your own features.
Before contributing please refer to our [contribution guidelines](https://github.com/Code-Society-Lab/grace/blob/main/docs/CONTRIBUTING.md) and [Code of Conduct for contributor (temporary unavailable)](#).
---
## Troubleshooting
If you're getting unexpected result, visit the wiki's [troubleshooting](https://github.com/Code-Society-Lab/grace/wiki/Troubleshooting)
page. For any other problems or questions ask us on our [discord server](https://discord.gg/code-society-823178343943897088).