Version 1.0

Author: mherrmann

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+dist/
+timer_cm.egg-info/

README.md

@@ -1,2 +1,47 @@
 # timer-cm
-A Python context manager for measuring execution time
+A Python context manager for measuring execution time.
+
+## Installation
+
+```
+pip install timer_cm
+```
+
+## Usage
+First, import the `Timer` class:
+
+```python
+from timer_cm import Timer
+```
+
+Then use it as a context manager. In this example we use Python's `sleep(...)` function to pause execution for one second:
+
+```python
+with Timer('Simple task'):
+    sleep(1)
+```
+
+This produces the following output:
+
+```
+Simple task: 1.005s
+```
+
+Often you want to know where a long running code block spends its time. Use `timer.child(name)` to track individual steps:
+
+```python
+with Timer('Long task') as timer:
+    with timer.child('First step'):
+        sleep(1)
+    for _ in range(5):
+        with timer.child('Many small steps'):
+            sleep(.5)
+```
+
+Output:
+
+```
+Long task: 3.520s
+  Many small steps: 2.518s (71%)
+  First step: 1.001s (28%)
+```

setup.py

@@ -0,0 +1,52 @@
+"""Measure execution time with a context manager
+
+See:
+https://github.com/mherrmann/timer-cm
+"""
+
+from setuptools import setup
+
+description = 'Measure execution time with a context manager.'
+setup(
+	name='timer-cm',
+
+	version='1.0',
+
+	description=description,
+	long_description=
+		description + '\n\nHome page: https://github.com/mherrmann/timer-cm',
+	url='https://github.com/mherrmann/timer-cm',
+
+	author='Michael Herrmann',
+	author_email='[my first name]@[my last name].io',
+
+	license='MIT',
+
+	platforms=['MacOS', 'Windows', 'Debian'],
+
+	classifiers=[
+		'Development Status :: 5 - Production/Stable',
+		'Intended Audience :: Developers',
+	
+		'License :: OSI Approved :: MIT License',
+	
+		'Operating System :: OS Independent',
+	
+		'Programming Language :: Python',
+		'Programming Language :: Python :: 2',
+		'Programming Language :: Python :: 2.7',
+		'Programming Language :: Python :: 3',
+		'Programming Language :: Python :: 3.2',
+		'Programming Language :: Python :: 3.3',
+		'Programming Language :: Python :: 3.4',
+		'Programming Language :: Python :: 3.5',
+		'Programming Language :: Python :: 3.6',
+	
+		'Topic :: Software Development :: Libraries',
+		'Topic :: Software Development :: Libraries :: Python Modules'
+	],
+
+	keywords='timer context manager',
+
+	py_modules=['timer_cm']
+)

timer_cm.py

@@ -0,0 +1,42 @@
+from timeit import default_timer
+from decimal import Decimal
+
+class Timer(object):
+	def __init__(self, name, print_results=True):
+		self.elapsed = Decimal()
+		self._name = name
+		self._print_results = print_results
+		self._start_time = None
+		self._children = {}
+	def __enter__(self):
+		self.start()
+		return self
+	def __exit__(self, *_):
+		self.stop()
+		if self._print_results:
+			self.print_results()
+	def child(self, name):
+		try:
+			return self._children[name]
+		except KeyError:
+			result = Timer(name, print_results=False)
+			self._children[name] = result
+			return result
+	def start(self):
+		self._start_time = self._get_time()
+	def stop(self):
+		self.elapsed += self._get_time() - self._start_time
+	def print_results(self):
+		print(self._format_results())
+	def _format_results(self, indent='  '):
+		result = '%s: %.3fs' % (self._name, self.elapsed)
+		children = self._children.values()
+		for child in sorted(children, key=lambda c: c.elapsed, reverse=True):
+			child_lines = child._format_results(indent).split('\n')
+			child_percent = child.elapsed / self.elapsed * 100
+			child_lines[0] += ' (%d%%)' % child_percent
+			for line in child_lines:
+				result += '\n' + indent + line
+		return result
+	def _get_time(self):
+		return Decimal(default_timer())