Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.98 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.98 KB

Winston


Winston is an open-source bot for discord written in python with the help of discord.py. It offers numerous utilities and moderation tools to enhance the experience of users on your discord server.

Running

Before proceeding please ensure you have installed python and poetry.

  1. Install the project dependencies with the following command:

    poetry install
  2. Rename the config.toml.example file to config.toml and fill in the required details.

  3. Run the bot with the following command:

    poetry run python -m bot

Contributing

I whole heartedly welcome all contributions to this project. When contributing please ensure to follow the guidelines listed below:

  1. When creating a new file please paste the license summary at the top of the file.

  2. This project uses black and isort to format the code. Please make sure you run the following command to format the code:

    black bot ; isort bot

License

This project is licensed under the AGPL-3.0 license. See the file LICENSE for more information. If you plan to use any part of this source code in your own discord bot, I would be really grateful if you include some form of credit somewhere.