Grace

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
1. Set up your app and token
2. Start the bot

0. Python and Dependencies

Install Python. Python 3.9 or higher is required.

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 your Discord bot. Then, create a file called .env in the project directory, open it and add DISCORD_TOKEN=<Your token>. (Replace by your discord token).

Do not share that file nor the information inside with anyone.

2. Start the Bot

The last part is to execute the bot. Execute grace start -e development to start Grace in development mode. The rest of the installation should complete itself and start the bot.

If the grace command is unrecognized, be sure that you installed the bot properly.

Script Usage

• Bot Command(s):
  • grace start : Starts the bot (ctrl+c to stop the bot)
• Database Command(s):
  • grace db create : Creates the database and the tables
  • grace db drop : Deletes the tables and the database
  • grace db seed : Seeds the tables (Initialize the default values)
  • grace db reset : Drop, recreate and seeds the database.

All commands can take the optional -e argument with a string to define the environment.
Available environment: (production [default], development, test)

We recommend using "development" (ex. grace start -e development)

---

Advance configurations

For advance configurations, visit the 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 and Code of Conduct for contributor (temporary unavailable).

---

Troubleshooting

If you're getting unexpected result, visit the wiki's troubleshooting page. For any other problems or questions ask us on our discord server.