Metadata-Version: 2.1
Name: deftimer
Version: 0.0.1
Summary: A very simple Python tool for process inspection and timer. (alpha)
Home-page: https://github.com/hakumizuki/deftimer
Author: Taichi Masuyama
Author-email: montanha.masu536@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/hakumizuki/deftimer/issues
Project-URL: Source, https://github.com/hakumizuki/deftimer/
Keywords: python,algorithms,timer,tools
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Requires-Dist: pathlib (==1.0.1)
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: flake8 ; extra == 'test'

# Alpha  
Deftimer is now alpha stage.  
Throw me issues!  

# Environments
```
Python: >=3.6, <4
```

# Requirements
```
pip install pathlib
```

# Try deftimer with docker
```
$ cd <parent dir of deftimer>
$ docker build -t deftimer .
$ docker run --rm deftimer
```

# deftimer
(TBD)  

English:  
It allows you to calculate run time of each functions. See USAGE.md for (more information)[https://github.com/hakumizuki/deftimer/blob/main/USAGE.md]  

```
timer = Timer()
@timer.use_timer
def do_something():
    ...

do_something() # this prints the results
```

Other functions:  
You can divide process into blocks and name them.  
Coming soon --> File exporting (JSON, CSV)  


Japanese:  
Python3の関数内の処理時間を計算します。  

```
timer = Timer()
@timer.use_timer
def do_something():
    ...
```

として関数を呼ぶだけで計測できます。  

他にも、、、  
Blockで処理を分割したり、処理に名前をつけたりできます。  
今後ファイル化(JSON、CSV)も考えています。  

# Test deftimer
```
$ docker run --rm deftimer python -m unittest
```
Note: It might fail depending on your pc spec.  

# Author
* Taichi Masuyama
* montanha.masu536@gmail.com

I always welcome your ideas!  
Thanks for visiting my repo :)  

# License
"deftimer" is under [MIT license](https://en.wikipedia.org/wiki/MIT_License)  


