Metadata-Version: 2.4
Name: cutime
Version: 1.0.0
Summary: Simple python decorators for measuring function execution times.
Project-URL: Homepage, https://github.com/CU-Software/cutime
Project-URL: Repository, https://github.com/CU-Software/cutime
Project-URL: Issues, https://github.com/CU-Software/cutime/issues
Author-email: Clarkson University Software Engineering Club <isaacsp@clarkson.edu>
License: MIT License
        
        Copyright (c) 2025 Clarkson University Software Engineering Club
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: benchmark,decorator,performance,python,timing
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# cutime

Simple python decorators for measuring function execution times.

---

### Installation
```bash
pip install cutime
```

---

### Usage
```python
from cutime import gettime, avgtime, sumtime

@gettime
def hello():
    print("Hello World!")

hello()
```

---

### Build & Install Locally

In the same directory as `setup.py`, run:

```bash
pip install build
python -m build
```

### Publishing

#### Step 1 - Install needed Tools
```bash
pip install hatch twine
```

#### Step 2 - Build
```bash
hatch build
```

#### Step 3 - Test with TestPyPI
```bash
python -m twine upload --repository testpypi dist/*
```

#### Step 4 - Test the Test
```bash
pip install -i https://test.pypi.org/simple/ cutime
```

#### Step 5 - Real Upload
```bash
python -m twine upload dist/*
```

### Expansions

#### New Decorators

| Category                    | Ideas                                                   |
| --------------------------- | ------------------------------------------------------- |
| **Better output control**   | Add options for logging results to file, CSV, or JSON.  |
| **Context manager support** | Add `with` syntax to measure arbitrary code blocks.     |
| **Pretty printing**         | Use `tabulate` or `rich` for formatted terminal output. |
| **Statistical summaries**   | Track mean, median, std deviation across runs.          |
| **Async support**           | Add timing decorators for `async def` functions.        | 
| **Profiling integration**   | Integrate with Python’s `cProfile` or `timeit`.         |
| **Custom reporting hooks**  | Allow users to supply callbacks for each timing.        |

#### Better Packaging

| Area          | Expansion                                                |
| ------------- | -------------------------------------------------------- |
| **CLI tool**  | Add a command-line utility: `python -m cutime script.py` |
| **Docs site** | Add documentation via MkDocs or Sphinx                   |
| **Tests**     | Add pytest-based test suite                              |
| **Badges**    | Add shields.io badges (version, license, PyPI)           |

