Installation

Prerequisites

• Python 3.8+

• SQLite

• yarn (for development only)

• Vue CLI (for development only)

Installation

from PyPI

• install with pip

$ pip install rdltr

• export the database location and secret key environment variables.

If needed, the default configuration can be overridden:

variable	description	app default value
RDLTR_SETTINGS	application configuration	“rdltr.config.ProductionConfig”
RDLTR_DB_URL	database location	no defaut value, must be initialized
RDLTR_SECRET_KEY	application secret key	no defaut value, must be initialized
RDLTR_LOG	application log file	no default value (log printed on the console)
RDLTR_HOST	host used by gunicorn	localhost
RDLTR_PORT	port used by gunicorn	5000
RDLTR_WORKERS	number of workers spawned by gunicorn	calculated
RDLTR_ALLOW_REGISTRATION	is users registration allowed ?	true

• initialize the database

$ rdltr_db

• run the application

$ rdltr

from source (for development)

• Clone this repo:

$ git clone https://github.com/SamR1/rdltr.git
$ cd rdltr

• Update Makefile.config file if needed

• Install Python virtualenv, and related packages and initialize the database:

$ make install
$ make upgrade-db

• Start the server:

  • to use with the front-end server: make serve and open http://localhost:8080/static

  • to only use build source: make run and open http://localhost:5000

Upgrade

Warning

Before upgrading, make a backup of SQLITE database.

from PyPI

• upgrade with pip

$ pip install -U rdltr

• if needed, upgrade database

$ rdltr_db

• restart the application

from source (for development)

• Pull this repo:

$ cd rdltr
$ git pull

• if needed, upgrade database

$ make upgrade-db

• restart the application