Metadata-Version: 2.1
Name: ez-timer
Version: 0.0.2
Summary: The simplest way to time a block of code.
Home-page: https://github.com/lukewood/ez-timer
Author: Luke Wood
Author-email: lukewoodcs@gmail.com
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
Provides-Extra: tests

# ez-timer

__The easiest way to time a code block in Python.__

Quick Links:
- [Installation](#Installation)
- [Usage](#Usage)
- [Overview](#Overview)

## Overview
`ez-timer` provides a single, easy to use API for timing function calls.

```python
with ez_timer() as timer:
    1 + 1
timer.result
# 0.000001
```

That is it.  That is the API.  Solves one problem, and solves it well.

### Background
When working on extensive profiling for an enterprise Python project I regularly found myself writing:

```python
start = time.time()
# some code
end = time.time()

result = end - start
# do something with result
```

While `timeit` exists, I found `timeit` to be heavy handed for what I needed in 90% of cases.
This inspired me to create `ez-timer`.

## Installation
ez-timer can be installed from pypi:

```bash
pip install ez-timer
```

## Usage
Using ez-timer is simple:

```python
from ez_timer import ez_timer

with ez_timer() as timer:
  # run expensive computation
  time.sleep(1)

print(timer.result)
# > 1.0001
```

That's all.  That is the API.


