Skip to content

A Discord bot for the Bulldog Computer Club using discord.py

License

Notifications You must be signed in to change notification settings

Bulldog-Computer-Club/inu

Repository files navigation

Inu

A Discord bot for the Bulldog Computer Club using discord.py.

Installation

  1. Clone the repository locally:
    $ git clone https://github.com/Bulldog-Computer-Club/inu
  2. Navigate to the newly created folder:
    $ cd inu
  3. Copy .env.example to .env and fill it out with the necessary configuration values.

After this, there are two possibilities:

Running standalone

Note: Running standalone requires more work in general, but is beneficial for fast iteration when developing.

  1. Set up Poetry, which is used for package management and build control.
  2. Install all dependencies:
    $ poetry install
  3. Run the bot.py file:
    $ poetry run python bot.py

Running via Docker

Note: Running via Docker is recommended for production instances, but may have a relatively low start-up speed compared to running standalone.

  1. Ensure that Docker is installed on your system.
  2. 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.

Contributing

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.

Development Tools

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.

License

Inu is licensed under the MIT license. It is maintained by the organizers of the Bulldog Computer Club, with help from club members.

About

A Discord bot for the Bulldog Computer Club using discord.py

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published