Installation

Table of contents

  1. Requirements
  2. Install from PyPI (recommended)
  3. First run
  4. Docker
    1. Scheduled refresh (RUN_TIME)
  5. Install from source
  6. About this fork

Requirements

  • Python 3.8 or higher
  • pip (use pip3 if pip points to Python 2)

Windows users: run these commands in PowerShell or Terminal.


pip install deemon-redux

Install a specific version:

pip install deemon-redux==2.25

Upgrade an existing install:

pip install --upgrade deemon-redux

First run

deemon -V
deemon --init
deemon monitor

deemon --init creates the config, database, and logs under:

  • Linux: ~/.config/deemon-redux
  • macOS: ~/Library/Application Support/deemon-redux
  • Windows: %appdata%\deemon-redux

Next step: configuration.


Docker

Images are published on each release to GitHub Container Registry.

docker pull ghcr.io/mon5termatt/deemon-redux:latest

First-time setup and one-shot refresh:

docker run --rm -it \
  -v deemon-redux-config:/config \
  -v ~/Music:/downloads \
  ghcr.io/mon5termatt/deemon-redux:latest --init

docker run --rm -it \
  -v deemon-redux-config:/config \
  -v ~/Music:/downloads \
  ghcr.io/mon5termatt/deemon-redux:latest refresh

Scheduled refresh (RUN_TIME)

Set RUN_TIME (or run_time) to HH:MM (24-hour) to keep the container running and run deemon refresh once per day at that time. Use TZ for the timezone:

docker run -d --name deemon \
  -e RUN_TIME=06:00 \
  -e TZ=America/Chicago \
  -v deemon-redux-config:/config \
  -v ~/Music:/downloads \
  ghcr.io/mon5termatt/deemon-redux:latest

Without RUN_TIME, the image behaves like a normal CLI (deemon <command>).

Configuration is stored in the /config volume (~/.config/deemon-redux inside the container).


Install from source

For development or contributing:

git clone https://github.com/mon5termatt/deemon-redux.git
cd deemon-redux
python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -r requirements.txt
pip install -e .
deemon --help

Without activating the virtualenv, use the repo wrapper:

./bin/deemon monitor

Install directly from GitHub without cloning:

pip install git+https://github.com/mon5termatt/deemon-redux.git

About this fork

Deemon Redux is a continuation of the archived deemon project, maintained at mon5termatt/deemon-redux.

The deemon command is unchanged for compatibility with existing scripts and workflows.


Deemon Redux is a continuation of the archived deemon project.