perfwatch

Name	perfwatch JSON
Version	1.3.2 JSON
	download
home_page	None
Summary	Python code performace metrics calculation tool
upload_time	2024-06-05 19:28:50
maintainer	None
docs_url	None
author	Khushiyant
requires_python	<4.0,>=3.10
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Perfwatch

Perfwatch is a python package that allows you to monitor the performance of your code. It is designed to be used in a Jupyter notebook, but can also be used in a Python script.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Installation

To install perfwatch, run the following command:

```bash
pip install perfwatch
```

## Development

To install perfwatch for development, clone the repository and run the following command:

```bash
poetry install
```
To setup pre-commit hooks, run the following command:

```bash
poetry run pre-commit install
```

To run the tests, run the following command:

```bash
poetry run pytest
```

## Usage

```python
from perfwatch import profile_decorator

@profile_decorator(["line", "cpu", "time"])
def test():
    for _ in range(1000000):
        pass

if __name__ == "__main__":
    test()
```

## License

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "perfwatch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Khushiyant",
    "author_email": "khushiyant2002@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/da/31/4f081db49607ada7877dd5b6f287081e45207234062cd6cda59473dcca8e/perfwatch-1.3.2.tar.gz",
    "platform": null,
    "description": "# Perfwatch\n\nPerfwatch is a python package that allows you to monitor the performance of your code. It is designed to be used in a Jupyter notebook, but can also be used in a Python script.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n## Installation\n\nTo install perfwatch, run the following command:\n\n```bash\npip install perfwatch\n```\n\n## Development\n\nTo install perfwatch for development, clone the repository and run the following command:\n\n```bash\npoetry install\n```\nTo setup pre-commit hooks, run the following command:\n\n```bash\npoetry run pre-commit install\n```\n\nTo run the tests, run the following command:\n\n```bash\npoetry run pytest\n```\n\n## Usage\n\n```python\nfrom perfwatch import profile_decorator\n\n@profile_decorator([\"line\", \"cpu\", \"time\"])\ndef test():\n    for _ in range(1000000):\n        pass\n\nif __name__ == \"__main__\":\n    test()\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python code performace metrics calculation tool",
    "version": "1.3.2",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3ede8b0d786e31e97a4a5f804550d436ea67e32c4e2b51423d8cad9ceabf7348",
                "md5": "d36baeb23fa11eab40ceb537c82f2570",
                "sha256": "51c0db77a250b2d85c622b1a53b86db03c6b6957225417652bdd788949b99397"
            },
            "downloads": -1,
            "filename": "perfwatch-1.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d36baeb23fa11eab40ceb537c82f2570",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 6189,
            "upload_time": "2024-06-05T19:28:49",
            "upload_time_iso_8601": "2024-06-05T19:28:49.017555Z",
            "url": "https://files.pythonhosted.org/packages/3e/de/8b0d786e31e97a4a5f804550d436ea67e32c4e2b51423d8cad9ceabf7348/perfwatch-1.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "da314f081db49607ada7877dd5b6f287081e45207234062cd6cda59473dcca8e",
                "md5": "435d5d2d7a6ef06fe4fbd35c60691413",
                "sha256": "1ccc59e89e1b2c34c71da5ac7290504bdc7fd7cae1a0dd1009bff18937165a7a"
            },
            "downloads": -1,
            "filename": "perfwatch-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "435d5d2d7a6ef06fe4fbd35c60691413",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 4471,
            "upload_time": "2024-06-05T19:28:50",
            "upload_time_iso_8601": "2024-06-05T19:28:50.277175Z",
            "url": "https://files.pythonhosted.org/packages/da/31/4f081db49607ada7877dd5b6f287081e45207234062cd6cda59473dcca8e/perfwatch-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-05 19:28:50",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "perfwatch"
}