Skip to content

pindjouf/std

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Simple Timer Daemon (STD)

A lightweight and configurable timer daemon that helps you manage work and break periods. STD is designed to run as a background service and is perfect for study sessions, coding sprints, or any focused work that benefits from structured breaks.

Features

  • Configurable work/break periods
  • Audio notifications when periods end
  • Clean countdown display
  • Automatic transitions between work and break periods
  • Simple config file in TOML format

Requirements

  • Python 3.12+
  • mpg123 (for audio notifications)
  • Required Python packages:
    • tomllib (included in Python 3.11+)

Quick Install

Run this:

git clone https://github.com/pindjouf/std.git && cd std && chmod +x std && ./std start

Install mpg123 for your system:

  • Ubuntu/Debian: sudo apt install mpg123
  • macOS: brew install mpg123
  • Windows: Download from the official mpg123 website

Usage

Start a study/work session:

python std start

I suggest just putting it in your /usr/local/bin while I work on turning it into a deamon:

sudo mv std /usr/local/bin/std && std start

Configuration

On first run, you can choose to create a default configuration file Which will be created at ~/.config/std/config.toml with these settings:

work_period = 90    # Work period in minutes
break_period = 20   # Break period in minutes
sound_file = "/path/to/sound.mp3"  # Notification sound

Edit these values to match your preferred study/break schedule.

Current Status

This is version 0.1.1, an MVP release. Core functionality is working, but some features are still in development:

  • ✅ Basic timer functionality
  • ✅ Work/break cycles
  • ✅ Audio notifications
  • ❌ Pause/resume (coming soon)
  • ❌ Session statistics (planned)
  • ❌ Status command (planned)

Contributing

This is a personal project in active development. Feel free to open issues for bugs or feature suggestions!

License

This project is licensed under the WTFPL License - see the LICENSE file for details.