exclock 0.2.8.1

exclock is a cui extended timer.

exclock is a cui extended timer.

Required

• mplayer

• xmessage or terminal-notifier(If you use mac, I recommend terminal-notifier)

How to install

$ pip install exclock

Usage

$ exclock [options] {clock-filename}

Features

• Sound an alarm at a specified time.

• Sound the alarm after the specified time has elapsed.

• You can flexibly set the alarm.

Options

• –version: show program’s version number and exit

• -h, –help: show this help message and exit

• -l, –list: show clock names in your PC and exit

• -t, –time: Time which spends until or to specified

• -r, –ring-filename: Sound-filename which used for ringing with -t, –time option. Note that you can use EXCLOCK_RING_FILENAME system variable if you often indicate ring-filename option.

• –trace, –traceback: show traceback

How to sound an alarm at a specified time

Enter

$ exclock -t {time}

format command.

Where time is given in the {hour}:{min} or {hour}:{min}:{sec} format.

Ex.

$ exclock -t "1:00"
$ exclock -t "1:00:20"

How to sound the alarm after the specified time has elapsed

Enter

$ exclock -t {time}

format command.

Where time is given in the {sec}, {sec}s, {min}m or {min}m{sec}s.

Ex.

$ exclock -t 3
$ exclock -t 3s
$ exclock -t 2m
$ exclock -t 2m3s

How to flexibly set the alarm

Enter

$ exclock {clock-filename}

format command. Although {clock-filename} can be omitted as descrived below.

clock-file should be a file in json5 format.

Official page for json5 format is Here.

clock file format

{
  "title": "title(optional)",
  "sounds": {
    "time1": {
      "message": "message1",
      "sound_filename": "sound_filename1",
    },
    "time2":{
    "message": "message2",
    "sound_filename": "sound_filename2",
    },
    ...
  },
  "loop": loop_number(optional)
}

• title(Optional): string which be used for notification. Then the property is computed from clock-filename if this option is not indicated.

• sounds: dictionary from time to dictionary which includes message and sound_filename.

  • time format is “{sec}”, “{sec}s”, “{min}m” or “{min}m{sec}s” format.

  • message is a string which be used for notification and terminal output. Then message is replaced by “{count}” to number of how many times execute.

  • sound_filename is a string which be used for play the sound.

• loop(Option): number of iterations for above clock timer. If this is nil, this means repeatation a number of times. Default value is 1.

There are sample files in sample dir in gitlab.

How to omit clock filename

Clock filename can be omitted for some case.

Rules are

• If extension of clock filename is .json5, extension can be omitted(ex: pomodoro.json5 => pomodoro).

• If dir is in the specified directory(~/.config/exclock/clock/ or environment variable EXCLOCK_CLOCK_DIR), dir is omitted (ex: ~/.config/exclock/clock/abc.json5 => abc).

• Buitin clock file can be accessed. There are in sample dir in gitlab (ex: 3m or pomodoro).

How to omit sound filename

Sound filename can be omitted for some case.

Rules are

• If dir is in the specified directory(~/.config/exclock/sound/ or environment variable EXCLOCK_SOUND_DIR), dir is omitted (ex: ~/.config/exclock/sound/abc.mp3 => abc.mp3).

• Buitin sound file can be accessed. There are in sample sound dir in gitlab (ex: silent.mp3 or ring.mp3).

LICENSE

Apache 2.0

Todo

• [-] exclock/sound/ring.mp3もしくはexclock/sound/ring.wavがあったら それをringに使うようにする

• [-] システムでデフォルトで使われている音声ファイル名をclock_fileに埋め込めるようにする

• [x] システムでデフォルトで使われている音声ファイルをデフォルトで使うようにする

• [ ] property based test試してみる(Ref: https://pypi.org/project/pytest-quickcheck/)

• [ ] aliasを設定できる設定ファイルを置けるように

  • [ ] 環境変数から設定ファイルを拾えるように

• [x] __でシステム内のファイルを指す仕様, 止める

• [-] inner_strを消す

• [ ] add tests to main function

• [ ] abcを消す

• [x] add Type for main function

• [x] split main function

• [x] default value of loop to 1