Metadata-Version: 2.4
Name: miniprofiler
Version: 0.0.2
Summary: Mini profiler tool for your projects
Author: Kadir Aksoy
License-Expression: MIT
Project-URL: homepage, https://github.com/kadir014/miniprofiler
Project-URL: bugtracker, https://github.com/kadir014/miniprofiler/issues
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# miniprofiler
Mini profiling tool for your projects.



# Usage
```py
from miniprofiler import Profiler

profiler = Profiler()

# Collect N samples, this can be an unlimited loop as well
# for example your game loop
for _ in range(N):
    with profiler.profile("render"):
        # Your rendering code goes here

stat = profiler["render"]
print(f"Rendering took {stat.avg} seconds on average, with a minimum time of {stat.min} seconds.")
```



# Installation
Install via PyPI:
```shell
$ pip install miniprofiler
```
or just copy-paste `miniprofiler` into your project.



# License
[MIT](LICENSE) © Kadir Aksoy
