Metadata-Version: 2.1
Name: functimer
Version: 1.0.5
Summary: A decorator/wrapper package to time a given function.
Home-page: https://github.com/EJEmmett/functimer
License: MIT
Keywords: timer,timed,timing,function,decorator
Author: Edward Emmett
Author-email: edemms12@gmail.com
Maintainer: Edward Emmett
Maintainer-email: edemms12@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: numpy (>=1.20.2,<2.0.0)
Project-URL: Repository, https://github.com/EJEmmett/functimer.git
Description-Content-Type: text/markdown

# functimer

A decorator/wrapper package to time a given function.

[![PyPI version](https://badge.fury.io/py/functimer.svg)](https://badge.fury.io/py/functimer)

---
### Installation
PYPI:

    pip install functimer

Manual:

    poetry build
    pip install dist/*.whl

How to install [Poetry](https://python-poetry.org/docs/#installation).

### Quick Example
Comprehensive Examples in `examples`
```py
@timed(unit=Unit.second, number=1)
def timed_sleep(seconds):
    sleep(seconds)

runtime = timed_sleep(1)
"1.00 s"
```

### Tests
Run `pytest` in the root directory of the repo.

### License
MIT

