smalltime 0.0.7

A small python timing package for a packaging demonstration

smalltime

---

What is it?

smalltime is a quick and dirty library for timing Python function, sections of code and arbitrary programs on the command line.

---

Requirements

smalltime requires Python >= 3.6.2.

See pyproject.toml for dependencies and dev dependencies.

---

Installation

Via poetry:

poetry add smalltime

Via pip:

pip install smalltime

---

Basic Usage

In Python Code

In-Line

import smalltime

timer = smalltime.Timer(name="hello world timer")
timer.start()
print("Hello, ", end="")
print("World!")
timer.stop()

Via Decorator

import smalltime
import subprocess

@smalltime.timed(name="thing_timer")
def thing_you_want_to_time():
    subprocess.call(["python", "-c", "\"import this\""])


thing_you_want_to_time()

From the Command Line

N.B.: Assumes installation via Poetry and an active Poetry shell.

# Usage: st <program> [args]
st sleep 10
Starting counter (BNM8rBqP)
Counter stopped (BNM8rBqP): 10007777130ns elapsed

---

Can I use this in my project?

Yes, please do! The code is all open source and BSD-3-Clause licensed.

---