Metadata-Version: 2.1
Name: fastbench
Version: 0.1.0
Summary: A pure-python based benchmarking package for Python 🤪
Author: Adarsh Gourab Mahalik
Author-email: gourabmahalikadarsh@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: psutil (>=5.9.8,<6.0.0)
Description-Content-Type: text/markdown


<h1 align="center">
  <br>
  <img src="./truebench.svg" width="200" height="200">
  <br>
  TrueBench
  <br>
</h1>

<p align="center">
  <a href="#features">Features</a> •
  <a href="#installation">Installation</a> •
  <a href="#usage">Usage</a> •
  <a href="#contributing">Contributing</a> •
  <a href="#license">License</a>
</p>

TrueBench is a high-performance Python package for benchmarking code execution time, CPU usage, and memory usage. It's implemented in Python for simplicity and provides a simple API for measuring the performance of your Python code.

## ✨ Features

- 🕰️ Measure the execution time of a function or code block
- 🖥️ Track CPU usage during code execution
- 💾 Monitor memory usage during code execution
- ⚡ Lightweight and fast
- 🤏 Simple and easy-to-use API

## 📦 Installation

You can install TrueBench via pip:

```bash
pip install truebench
```

## 🔧 Usage

Here's an example of how to use TrueBench to benchmark Python code:

```python
from truebench import mt, mc, mm

# Define a sample function for testing
def sample_function(n):
    return sum(range(n))

# Test the mt function (measure execution time)
time_taken = mt(sample_function, n=1000000)
print("Time taken:", time_taken)

# Test the mc function (measure CPU usage)
cpu_usage = mc(sample_function, n=1000000)
print("CPU usage:", cpu_usage)

# Test the mm function (measure memory usage)
memory_usage = mm(sample_function, n=1000000)
print("Memory usage:", memory_usage)
```

## 🤝 Contributing

Contributions are welcome! Check out the [Contribution Guidelines](CONTRIBUTING.md).

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
