A Discord bot for the Bulldog Computer Club using discord.py.
- Clone the repository locally:
$ git clone https://github.com/Bulldog-Computer-Club/inu
- Navigate to the newly created folder:
$ cd inu
- Copy
.env.example
to.env
and fill it out with the necessary configuration values.
After this, there are two possibilities:
Note: Running standalone requires more work in general, but is beneficial for fast iteration when developing.
- Set up Poetry, which is used for package management and build control.
- Install all dependencies:
$ poetry install
- Run the
bot.py
file:$ poetry run python bot.py
Note: Running via Docker is recommended for production instances, but may have a relatively low start-up speed compared to running standalone.
- Ensure that Docker is installed on your system.
- Use Compose to start the bot service:
$ docker-compose up # or, if developing $ docker-compose up --build bot
If developing, it is recommended to comment out the restart policy in the Compose file.
Thank you for considering contributing to Inu; bug-fixes and new features are always appreciated. If working on a major feature, it may be prudent to open an issue to discuss design and implementation prior to diving in to avoid any surprises down the line.
Black is used for code formatting and Flake8 for style enforcement. Having these tools and relevant editor integrations installed will be a major boon for development.
Inu is licensed under the MIT license. It is maintained by the organizers of the Bulldog Computer Club, with help from club members.