Skip to content

strinking/futaba

Repository files navigation

futaba

picture of futaba

A Discord bot for the Programming server.

Requires Python 3.6 or later. There is a sample configuration file at misc/config.toml.

Running locally

Setup:

$ pip3 install poetry
$ poetry install
$ docker run -e POSTGRES_PASSWORD=password -p 5432:5432 postgres
$ cp misc/config.toml config.toml
# set database.url to "postgresql://postgres:password@localhost"

To run:

$ python3 -m futaba <config.toml>

Development

More setup:

$ poetry install --with dev

Formatting and linting code:

$ black futaba
$ pylint futaba

Deployment

You can have a production system, complete with a systemd service file, by running the provided deploy.sh script. If there is a futaba.service file in the repository root, that service is installed, otherwise the one in misc/ is used.

Usage:

$ ./deploy.sh <config.toml>

Installs dependencies, installs the service and configuration files, then restarts the unit.