Metadata-Version: 2.1
Name: tepet
Version: 0.1.0
Summary: Small timing tool to run performance analysis
Home-page: https://github.com/toshakins/tepet
Author: Anton Ovinnikov
Author-email: toshakins@gmail.com
Requires-Python: >= 3.7
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License

# tepet
**TE**mporal **PE**rformance **T**ool

~~25-cent term for a 5-cent concept!~~

[![PyPI](https://img.shields.io/pypi/v/tepet)](https://pypi.org/project/tepet/)
[![Test Python package](https://github.com/Toshakins/tepet/actions/workflows/python-package.yml/badge.svg)](https://github.com/Toshakins/tepet/actions/workflows/python-package.yml)

## What is this
tepet is a small utility to help you understand and track execution time of your code. You could write it anytime, but why do this every other day?

## Usage
Can be used as a context manager

```python
from tepet import PerfTimer

with PerfTimer():
    print('doing stuff...')

# Output:
#
# > 2020 May 31 20:11:49 +0000 ==== started
# > doing stuff...
# > 2020 May 31 20:11:49 +0000 ==== elapsed 0.00000 seconds
```
and a function decorator
```python
from tepet import PerfTimer
@PerfTimer()
def work():
  print("working...")

work()

# Output:
#
# > 2020 May 31 20:14:25 +0000 ==== started
# > working...
# > 2020 May 31 20:14:25 +0000 ==== elapsed 0.00001 seconds
```

Also, can be used in production environments for naive tracking:

```python
from tepet import Timer

def printer(seconds):
        print(f'code block 1: {seconds:.5f} elapsed')

with Timer(printer):
    ...

# Output:
# > code block 1: 0.00000 elapsed
```

