SPARK is the all-in-one wonderbot written and utilized by The Fuel Rats for rescue management. This project is under active development. As such, features may be added or removed without notice.
As this project is under heavy development, we cannot offer support at this time. However, please do report bugs or issues on our project here.
SPARK is currently incomplete.
- Python 3.8
- PostgreSQL
poetry
on top of pip you must have installed
poetry, this guide assumes this fact.
If you are not using poetry, please see pyproject.toml for the list of required libraries. You will need to install these libraries manually.
- Clone the repository from the
masterbranch, or for bleeding edge, usedevelop. Please keep in mind, Develop changes frequently and may be broken. - Install the project's requirements,
poetry install --no-root - once installed, activate the venv
poetry shell - Build your configuration file. Please see the Configuration section.
- Start infrastructure services (irc, ircservices, db). There is a docker-compose file readily available that will do it for you:
docker-compose.template.ymlfeel free to use it directly withdocker-compose -f docker-compose.template.yml upor rename it todocker-compose.ymland customize it the way you see fit. - Execute Mecha with
python -m src --config <your configuration file>(You may need to use the python3 alias)
| Flag | Description |
|---|---|
| --clean-log | New log file. Old one is deleted. |
| --config-file file.json | Use configuration file file.json |
| --verbose | Verbose mode. (Logging level set to Debug) |
| --nocolors | Disable ANSI color coding in console. |
Configuration settings are stored in the config/ subfolder as JSON files.
By default, Mecha will attempt to load configuration.toml (file not provided) from this subdirectory.
To configure Mecha locally, please copy the provided config.template.toml to a new file.
configuration.toml and fill in the appropriate fields, see config/configuration.md for details.