package owork

  1. Overview
  2. Docs
A productivity timer for focusing on work

Install

Dune Dependency

Authors

Maintainers

Sources

owork-0.1.1.tbz
sha256=d35630a90700fcee9451709b1fc85ecc1381a67cd122fd7949b15e72c6c1143a
sha512=a86e40cf88ffccc0d41626f6d5c03eefbeee988f011052148f71406ed0d13f568b91e53e64b32e667f069bf831fca9846a88f838b73bd8ccbe9b873b6ddfa98e

Description

Owork is a productivity timer. It provides a server executable which uses a state machine to start different timers for sessions. There are four states: idle, working, short break and long break.

Published: 04 Nov 2019

README

owork

An OCaml implementation of a productivity timer. There is a server component at the moment which accepts connections over a Unix socket. The timer can then be started, paused/resumed, reset and sessions restarted.

Install

To install the program, first clone the repo and then run make install (Note: opam may be required to install necessary packages):

git clone https://github.com/jeffa5/owork.git
cd owork
make install
owork --help

Socket file

The default socket file is created at /tmp/owork.sock. This can be overridden with a command-line option.

Protocol

The protocol is outlined in PROTOCOL.md

Examples

Some example client scripts to interact with the server can be found in the examples directory.

Dependencies (11)

  1. ppx_expect >= "0.12"
  2. ppx_deriving >= "4.3"
  3. lwt_ppx >= "1.2"
  4. lwt >= "4.2"
  5. logs >= "0.6"
  6. fmt >= "0.8"
  7. duration >= "0.1"
  8. cmdliner >= "1.0"
  9. astring >= "0.8"
  10. ocaml >= "4.04.0"
  11. dune >= "1.10"

Dev Dependencies

None

Used by

None

Conflicts

None