Metadata-Version: 2.4
Name: comprobot
Version: 2.5.1
Summary: A self-hostable Discord bot built for maximum customization.
Author: badluma
License: MIT
Project-URL: Homepage, https://badluma.github.io/Comprobot-Docs
Project-URL: Repository, https://github.com/badluma/comprobot
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: discord.py[voice]
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: tomlkit
Requires-Dist: appdirs
Requires-Dist: ollama
Requires-Dist: httpx
Requires-Dist: InquirerPy
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

# Comprobot

Comprobot is a highly-customizable, open-source Discord bot that you can run on your own server.

It’s built with Python, has a wide range of fun and useful commands, and is designed to be easy to extend. 
You can add new commands, customize outputs, or change the behaviour of existing ones. You can also easily edit the keywords of existing commands and customize their outputs.

The bot also comes with built-in AI capabilities when pinging the bot, with Ollama, Groq and Gemini as available providers.

## Install

**pipx** (All platforms)
```sh
pipx install comprobot
```

**APT** (Ubuntu/Debian/Kali)
```sh
# If add-apt-repository isn't found, run this first:
# sudo apt install software-properties-common
sudo add-apt-repository ppa:badluma/ppa
sudo apt update
sudo apt install comprobot
```

**AUR** (Arch)
```sh
yay -S --noconfirm --nodiffmenu comprobot
```

**Homebrew** (macOS)
```sh
brew tap badluma/tap
brew install comprobot
```

**Winget** (Windows)
```sh
winget install badluma.comprobot
```

**Scoop** (Windows)
```sh
scoop bucket add badluma https://github.com/badluma/scoop-bucket
scoop install comprobot
```

**Docker** (All platforms)

Set up credentials first:
```sh
docker run -it --rm \
  -v comprobot-data:/root/.local/share/Comprobot \
  badluma/comprobot:latest onboard
```

Then start the bot:
```sh
docker run -d \
  -v comprobot-data:/root/.local/share/Comprobot \
  --name comprobot \
  badluma/comprobot:latest
```

## Documentation

You can find the whole documentation [here](https://badluma.github.io/Comprobot-Docs/).

## License

MIT
