Canary is a Python3 bot designed for the McGill University Community Discord Server. The bot provides helper functions to users, as well as fun functions, a quote database and custom greeting messages.
| Master |  |
|---|---|
| Dev |  |
If you wish to use the update command to update to the latest version of the bot, configure your github account in
your environment of choice and clone into the repository with:
$ git clone https://github.com/idoneam/CanaryDependencies are managed with pipenv which can be installed via pip with:
$ python3 -m pip install pipenvDependencies may be installed using pipenv with the following command:
$ pipenv installDevelopment dependencies (YAPF) can be installed alongside all other dependencies with:
$ pipenv install --devYou may enter the virtual environment generated by the pipenv installation with:
$ pipenv shellOr simply run the bot with:
$ pipenv run python3 Main.pyIn order to run bots on Discord, you need to create a bot account.
Set your Discord bot token in the config.ini file within the config directory. Also change your Database file path as well as Greeting and Farewell messages, if desired.
Run python3 Main.py in your shell. Ensure that your Discord token is set in the config.ini file within the config directory.
We format our code using Google's YAPF. Our builds will reject code that do not conform to the standards defined in .style.yapf . You may format your code using :
$ yapf --recursive --in-place .
and ensure your code conforms to our linting with :
$ yapf --diff --recursive .
Contributions are welcome, feel free to fork our repository and Open a Pull Request or Open an Issue.