README.md

thym

Bundle of timing utilities such as Timer that allows you to trigger an event at a specified interval or Stopwatch to measure time etc.

Installation

There are two ways to install thym:

Install thym from PyPI (recommended):

sudo pip install thym

If you are using a virtualenv, you may want to avoid using sudo:

pip install thym

Alternatively: install thym from the GitHub source:

First, clone thym using git:

git clone https://github.com/apgeorg/thym.git

Then, cd to the thym folder and run the install command:

cd thym
sudo python setup.py install

Getting started

Timer

Timer is able to trigger a callback either periodically or as a one shot by setting the oneshot argument correspondingly. There is an elapsed property that returns the elapsed time since start() was called. Further, a remaining property is also available that returns the remaining time of the specified interval.

import thym

# Timer callback function
def timer_timeout():
  print("Timeout!")

# Create a Timer which runs periodically 
t = thym.Timer(1, timer_timeout, oneshot=False)

# Start running
t.start()

A running Timer can be stopped anytime by calling stop() as shown below. The elapsed time and remaining time are calculated accordingly.

t.stop()

Stopwatch

Stopwatch triggers a callback when stop() is called. The callback can be passed over the Stopwatch consturctor.
There is an elapsed property that returns the elapsed time since start() was called.

import thym

# Stopwatch callback function
def stopped_callback():
  print("Stopwatch stopped!")

# Create a Stopwatch 
sw = thym.Stopwatch(stopped_callback)

# Start running
sw.start()

A running Stopwach can be stopped anytime by calling stop() as shown below. Accordingly, the elapsed time is calculated.

sw.stop()

Licence

Thym is licensed under MIT. See LICENSE file for details.

Copyright © 2019 Apostolos Georgiadis.