Skip to content
This repository has been archived by the owner on Feb 18, 2023. It is now read-only.

Latest commit

 

History

History
45 lines (32 loc) · 2.49 KB

README.md

File metadata and controls

45 lines (32 loc) · 2.49 KB
Raw

Build Status

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.

Requirements

  • Python 3.8
  • PostgreSQL
  • poetry

Installation

NOTE:

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.

  1. Clone the repository from the master branch, or for bleeding edge, use develop. Please keep in mind, Develop changes frequently and may be broken.
  2. Install the project's requirements, poetry install --no-root
  3. once installed, activate the venv poetry shell
  4. Build your configuration file. Please see the Configuration section.
  5. Start infrastructure services (irc, ircservices, db). There is a docker-compose file readily available that will do it for you: docker-compose.template.yml feel free to use it directly with docker-compose -f docker-compose.template.yml up or rename it to docker-compose.yml and customize it the way you see fit.
  6. 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

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.