MathBot is a discord bot that contains a number of features to help with mathematics.
It's primary features are:
The bot is currently developed on python 3.8.10
, but should work on later versions of Python.
git clone https://github.com/DXsmiley/mathbot.git
cd mathbot
cp mathbot/parameters_default.json ./parameters.json
python3.8 -m venv .venv # or later version
source .venv/bin/activate
pip install -r requirements.txt
Then open parameters.json and change tokens
to the token of the bot used for development. Optionally change the other parameters.
It is strongly recommend that you setup an instance of Redis if you want to use the bot on even a moderate scale. The disk-based keystore is easy to setup but runs very slowly, and as such is only useful of a development tool.
Run the bot with python -m mathbot parameters.json
.
Follow above instructions, but additionally run pip install -r dev_requirements.txt
Relevent discussion takes place on the MathBot Discord server.
wolfram > key
.This should really only be used for development and personal use.
Invoke pytest
to run the test suite.
Some of the tests require that a bot is running and connected to Discord. To enable them, use the --run-automata
command line argument. In addition a file with the necessary tokens filled out needs to be provided to the --parameter-file
argument. To get all tests running, the token, automata and wolfram parameters need to be filled out.
For the sake of example, I run my tests with the command ./test --run-automata --parameter-file=dev.json
. You should replace dev.json
with a path to your own parameter file.
There are some additional tests that require a human to verify the bot's output. These can be enabled with --run-automata-human
.
parameters.json
"development"
, "beta"
or "production"
"disk"
or "redis"
, depending on which store you want to use. Disk mode is not recommended for deployment."linear"
, "quadratic"
, "exponential"
or "special"
. The string may contains additional information after this for human use, such as usernames or other notes.true
or false
. When true
, the bot will occasionally mention the Patreon page when running queries.0
) specifying which shards should be run in this process.If you don't have python 3.8
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.8
If you have installation troubles with cffi or psutil
sudo apt-get install python3.8-dev