Skip to main content

exclock is a cui extended timer.

Project description

PyPI PyPI - Python Version https://gitlab.com/yassu/exclock/badges/master/pipeline.svg https://gitlab.com/yassu/exclock/badges/master/coverage.svg PyPI - License

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exclock-0.2.10.2.tar.gz (70.6 kB view details)

Uploaded Source

Built Distribution

exclock-0.2.10.2-py3-none-any.whl (70.6 kB view details)

Uploaded Python 3

File details

Details for the file exclock-0.2.10.2.tar.gz.

File metadata

  • Download URL: exclock-0.2.10.2.tar.gz
  • Upload date:
  • Size: 70.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.9.0rc1 Darwin/19.3.0

File hashes

Hashes for exclock-0.2.10.2.tar.gz
Algorithm Hash digest
SHA256 340fa575435f039ec210d0f1d25fcb778723be376543f6a16d0c2224950c09ba
MD5 e8935be57c2a2baac45042cccbaad8e3
BLAKE2b-256 c83e0ee9e87c8d4fefb47f1d7bc98ef98c610f81637ca0d141d46a2329b8d755

See more details on using hashes here.

File details

Details for the file exclock-0.2.10.2-py3-none-any.whl.

File metadata

  • Download URL: exclock-0.2.10.2-py3-none-any.whl
  • Upload date:
  • Size: 70.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.9.0rc1 Darwin/19.3.0

File hashes

Hashes for exclock-0.2.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ef1a23f56dea03120cbd62c85526d19ebae0c6bb9b06921f11b9d471176e31a2
MD5 aa5983b00786094d232e92df1c9b4ab0
BLAKE2b-256 f267f5154e95b7983cce185006de16af1d2b9091f85d80d822abfc287245dda3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page