d8s-timer

Democritus Timer

Democritus functions^[1] for working with timers.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-timer

Usage

You import the library like:

from d8s_timer import *

Once imported, you can use any of the functions listed below.

Functions

• def timer_start(name: str = None) -> str:
      """Start a timer with the given name. Timers can be stopped with the `timer_stop` function."""
  

• def timer_get_time(name: str) -> float:
      """Get the current time for the timer with the given name."""
  

• def timer_stop(name: str) -> float:
      """Stop a timer (you can start a timer with the `timer_start` function)."""
  

• def time_it(func):
      """Return the time it takes func to execute."""
  

Development

👋  If you want to get involved in this project, we have some short, helpful guides below:

• contribute to this project 🥇
• test it 🧪
• lint it 🧹
• explore it 🔭

If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.

Credits

This package was created with Cookiecutter and Floyd Hightower's Python project template.