Metadata-Version: 2.1
Name: syct
Version: 0.4.1
Summary: A Simple Yet Convenient Timer module for Python 3
Home-page: https://github.com/nadavo/Timer.git
Author: Nadav Oved
Author-email: nadavo@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown

# Simple Yet Convenient Timer for Python 3

### Installation
```
pip install syct
```

### Usage

##### Timer object:
```
timer_test = Timer("Timer Testing")
sleep(5)
timer_test.stop()
```
Will produce the following output:
```
<timestamp> - Started Timer Testing
<timestamp> - Timer Testing took 5.00 seconds to complete
```
##### @timer function decorator:
```
@timer
def test_timer_decorator():
    sleep(5)
```
Calling the function will produce the following output:
```
<timestamp> - Started test_timer_decorator
<timestamp> - test_timer_decorator took 5.00 seconds to complete
```
##### with Timer block:
```
with Timer("with Timer block"):
    sleep(1)
    sleep(1)
    sleep(1)
    sleep(1)
    sleep(1)
```
Will produce the following output:
```
<timestamp> - Started with Timer block
<timestamp> - with Timer block took 5.00 seconds to complete
```


