timerun

TimeRun - Python library for elapsed time measurement.

TimeRun is a simple, yet elegant elapsed time measurement library for Python. It is distributed as a single file module and has no dependencies other than the Python Standard Library.

• Elapsed Time: Customized time delta which represents elapsed time in nanoseconds
• Stopwatch: An elapsed time measurer with the highest available resolution
• Timer: Convenient syntax to capture and save measured elapsed time results

Setup

Prerequisites

The only prerequisite to use TimeRun is running Python 3.9+.

Installation

Install TimeRun from Python Package Index:

pip install timerun

Install TimeRun from Source Code:

pip install git+https://github.com/HH-MWB/timerun.git

Quickstart

Measure Code Block

>>> from timerun import Timer
>>> with Timer() as timer:
...     pass  # put your code here
>>> print(timer.duration)
0:00:00.000000100

Measure Function

>>> from timerun import Timer
>>> timer = Timer()
>>> @timer
... def func():
...     pass  # put your code here
>>> func()
>>> print(timer.duration)
0:00:00.000000100

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines on how to contribute to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.