# timeitX - Function Execution Time Logger
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/timeitX/1.0.1)](https://pypi.org/project/timeitX/)
![GitHub issues](https://img.shields.io/github/issues/nitishsaik/timeitX)
[![PyPI version](https://badge.fury.io/py/timeitX.svg)](https://badge.fury.io/py/timeitX)
![GitHub](https://img.shields.io/github/license/nitishsaik/timeitX)
![GitHub](https://img.shields.io/github/issues/nitishsaik/timeitX)
![GitHub](https://img.shields.io/github/stars/nitishsaik/timeitX)
[![Downloads](https://pepy.tech/badge/timeitX/month)](https://pepy.tech/project/timeitX)
`timeitX` is a Python decorator that logs the execution time of functions, both for synchronous and asynchronous functions.
## Features
- Log the execution time of functions.
- Supports both synchronous and asynchronous functions.
- Customizable function names for logging.
- Precision down to milliseconds.
- Easy to integrate with your Python projects.
## Installation
You can install `timeitX` via pip:
```bash
pip install timeitX
```
## Usage
```python
from timeitX import timeitX
# Define your logger
import logging
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger("timeitX")
@timeitX(name="My Function", logger=logger)
def my_function():
# Your function code here
# For asynchronous functions
@timeitX(name="Async Function", logger=logger)
async def async_function():
# Your async function code here
```
Raw data
{
"_id": null,
"home_page": "",
"name": "timeitX",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "timeit,async timeit,async,timer,python",
"author": "Nitish Sai Kommaraju",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d9/86/7568c76d5ccede491801291dca6efbbd086186f84e8c55413bf6dfcb96c4/timeitx-1.0.2.tar.gz",
"platform": null,
"description": "# timeitX - Function Execution Time Logger\n\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/timeitX/1.0.1)](https://pypi.org/project/timeitX/) \n![GitHub issues](https://img.shields.io/github/issues/nitishsaik/timeitX)\n[![PyPI version](https://badge.fury.io/py/timeitX.svg)](https://badge.fury.io/py/timeitX)\n![GitHub](https://img.shields.io/github/license/nitishsaik/timeitX)\n![GitHub](https://img.shields.io/github/issues/nitishsaik/timeitX)\n![GitHub](https://img.shields.io/github/stars/nitishsaik/timeitX)\n[![Downloads](https://pepy.tech/badge/timeitX/month)](https://pepy.tech/project/timeitX)\n\n`timeitX` is a Python decorator that logs the execution time of functions, both for synchronous and asynchronous functions.\n\n## Features\n\n- Log the execution time of functions.\n- Supports both synchronous and asynchronous functions.\n- Customizable function names for logging.\n- Precision down to milliseconds.\n- Easy to integrate with your Python projects.\n\n## Installation\n\nYou can install `timeitX` via pip:\n\n```bash\npip install timeitX\n```\n\n## Usage\n\n```python\n\nfrom timeitX import timeitX\n\n# Define your logger\nimport logging\n\nlogging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')\n\nlogger = logging.getLogger(\"timeitX\")\n\n@timeitX(name=\"My Function\", logger=logger)\ndef my_function():\n # Your function code here\n\n# For asynchronous functions\n@timeitX(name=\"Async Function\", logger=logger)\nasync def async_function():\n # Your async function code here\n\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "timeitX - Function Execution Time Logger",
"version": "1.0.2",
"project_urls": null,
"split_keywords": [
"timeit",
"async timeit",
"async",
"timer",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f73033ab4fb54a7baf404c9c7a8eb5eb917f148bca32e537c64214c7435b2484",
"md5": "eaed976ad0250d4ed348263f50c4b888",
"sha256": "dc3b34b1505f36d570f8904819f2512b5a6383a1b77b0a4c0f321bdc9c99e479"
},
"downloads": -1,
"filename": "timeitx-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eaed976ad0250d4ed348263f50c4b888",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 11229,
"upload_time": "2023-11-08T05:05:24",
"upload_time_iso_8601": "2023-11-08T05:05:24.955411Z",
"url": "https://files.pythonhosted.org/packages/f7/30/33ab4fb54a7baf404c9c7a8eb5eb917f148bca32e537c64214c7435b2484/timeitx-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d9867568c76d5ccede491801291dca6efbbd086186f84e8c55413bf6dfcb96c4",
"md5": "749ece1f2ebb49086691862565cdabce",
"sha256": "a42d519d38f27b474917c3f104ecdbfe0e07f6dc65cf777bbb2c87d7c7e81b20"
},
"downloads": -1,
"filename": "timeitx-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "749ece1f2ebb49086691862565cdabce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 6089,
"upload_time": "2023-11-08T05:05:26",
"upload_time_iso_8601": "2023-11-08T05:05:26.260001Z",
"url": "https://files.pythonhosted.org/packages/d9/86/7568c76d5ccede491801291dca6efbbd086186f84e8c55413bf6dfcb96c4/timeitx-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-08 05:05:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "timeitx"
}