SyluxDX / daily-timer

A timer for Daily Standup meetings

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

daily-timer

A Timer for Daily Standup meetings for the terminal

For a timer with graphical interface see sister project Daily Timer GUI

Key Mapping

Key Action
Left Arrow Select previous participant on list
Right Arrow Select next participant on list
Space Toggle timer pause/resume
h Display/Hide help menu
q Exit application

Configurations

Name Type Description
time int limit of seconds after which enter in overtime
warning int Number of seconds when an warning wil be displayed
participants list of str List of team members
randomOrder bool Flag to randomize the participants list before each startup
stopwatch bool Function mode flag. True: stopwatch, False: countdown
stats.display bool Flag to display or hide statistics on member list
stats.lastDailies int Number of last dailies to include in the statistic calculations

Usage

You can use the --help option to get more details about the options

usage: daily_timer.py [-h] [-c CONFIG]

Timer for Daily Timer.

options:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        path for configuration

The flag CONFIG is used to choose which configuration/team to use in the timer, the default is team.json

Build from Source

Linux

  • Create a virtual enviroment
  • Install the requiments specified in the file requirements_linux.txt
  • Run PyInstaller on main script:
$ pyinstaller --onefile daily_timer.py

Windows

  • Create a virtual enviroment
  • Install the requiments specified in the file requirements_windows.txt
  • Run PyInstaller on main script:
$ pyinstaller daily_timer.py

The script compilation can be done with a single output file with the following line, but it may the flaged as a false-positve for virus and mallware. This is due to the executable not being signed, which requires paying for a certificate.

$ pyinstaller --onefile daily_timer.py

ToDo:

  • Scroll capabilities when there are more than 10 ten members
  • Add tooltip for keys at the bottom of screen
  • Test how make terminal responsive with windows size changes

About

A timer for Daily Standup meetings


Languages

Language:Python 100.0%