README.md

May 23, 2022 · View on GitHub

dev-bot dev-bot

CI Coverage Status

About

A discord bot built with discord.py

Features

❕Commands

  • 🗨️ Talks: hi, dm!
  • 💭 Quotes: quote!
  • Full list of commands: here.

🔔 Events

  • React when mentioned

Installation

These are the requirements for the bot.

Setup your .env configuration file:

$ cp example.env .env

Add yout own Discord AUTH_TOKEN (mandatory) and optionally setup your COMMAND_PREFIX. Then you should be able to start the bot by running:

# Start the bot
python app/bot.py

Development

To start developing install dev dependencies:

# `make install` can also get the job done
pip install -e .['dev']

Tests

# Run tests
pytest tests/ -v # or `make test`

# Run tests & coverage
pytest tests/ -v --cov=app

# Coverage report
coverage html

# Tip: use `make coverage` to run tests, coverage and browse the coverage report

License

Released under the MIT license.