| Name | delayviewer JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Several mechanisms to time and view progress of execution/runtime delays in Python |
| upload_time | 2024-10-07 01:32:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
util
utility
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DelayViewer
**DelayViewer** is a Python assistant for showing progress info visually within the shell running a python command with long exposure. This library provides a simple spinner graphic and a stopwatch. The predominant use case is to display progress for sections within a decorated function.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install **delayviewer**.
```bash
pip install delayviewer
```
## Spinner Usage
```python
from delayviewer.spinner import handle_spinner
import time
@handle_spinner
def test_spinner(spinner=None):
spinner.start('delaying 5 sec')
time.sleep(5)
spinner.stop()
test_spinner()
```
## Stopwatch Usage
```python
from delayviewer.stopwatch import handle_stopwatch
import time
@handle_stopwatch
def test_stopwatch(stopwatch=None):
stopwatch.start('clocking 5 sec')
time.sleep(5)
stopwatch.stop('Finished timing!')
test_stopwatch()
```
## CLI Utility
The following CLI is included with this package for testing the various progress and timing indicators.
```bash
# dlyview -h
usage: dlyview [-h] {spinner,stopwatch,time.show,sleep.ticks} ...
-.-.-. Delay viewer elements for python scripts
positional arguments:
{spinner,stopwatch,time.show,sleep.ticks}
spinner test Spinner graphic for viewing thru execution delays
stopwatch test StopWatch for viewing thru execution delays
time.show test time show wrapper
sleep.ticks test sleeping ticks progress viewer
options:
-h, --help show this help message and exit
.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Acknowledgements
Thanks to several posts on StackOverflow regarding basic Spinner class implementation. Took that concept and generated the Stopwatch class to mimic behavior.
Raw data
{
"_id": null,
"home_page": null,
"name": "delayviewer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Ed Waldner <waldevburry@proton.me>",
"keywords": "util, utility",
"author": null,
"author_email": "Ed Waldner <waldevburry@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/d5/0f/f9d445720c3b5479832930c8ee5875079cd5f83da3193aa619b430c08913/delayviewer-0.1.1.tar.gz",
"platform": null,
"description": "# DelayViewer\n\n**DelayViewer** is a Python assistant for showing progress info visually within the shell running a python command with long exposure. This library provides a simple spinner graphic and a stopwatch. The predominant use case is to display progress for sections within a decorated function.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install **delayviewer**.\n\n```bash\npip install delayviewer\n```\n\n\n## Spinner Usage\n```python\nfrom delayviewer.spinner import handle_spinner\nimport time\n\n@handle_spinner\ndef test_spinner(spinner=None):\n spinner.start('delaying 5 sec')\n time.sleep(5)\n spinner.stop()\n\ntest_spinner()\n```\n\n## Stopwatch Usage\n```python\nfrom delayviewer.stopwatch import handle_stopwatch\nimport time\n\n@handle_stopwatch\ndef test_stopwatch(stopwatch=None):\n stopwatch.start('clocking 5 sec')\n time.sleep(5)\n stopwatch.stop('Finished timing!')\n\ntest_stopwatch()\n```\n\n\n## CLI Utility\n\nThe following CLI is included with this package for testing the various progress and timing indicators.\n\n```bash\n# dlyview -h\nusage: dlyview [-h] {spinner,stopwatch,time.show,sleep.ticks} ...\n\n-.-.-. Delay viewer elements for python scripts\n\npositional arguments:\n {spinner,stopwatch,time.show,sleep.ticks}\n spinner test Spinner graphic for viewing thru execution delays\n stopwatch test StopWatch for viewing thru execution delays\n time.show test time show wrapper\n sleep.ticks test sleeping ticks progress viewer\n\noptions:\n -h, --help show this help message and exit\n\n.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.\n```\n\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n## Acknowledgements\n\nThanks to several posts on StackOverflow regarding basic Spinner class implementation. Took that concept and generated the Stopwatch class to mimic behavior.\n",
"bugtrack_url": null,
"license": null,
"summary": "Several mechanisms to time and view progress of execution/runtime delays in Python",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://github.com/ew98/delayviewer/wiki/DelayViewer",
"Homepage": "https://github.com/ew98/delayviewer",
"Issues": "https://github.com/ew98/delayviewer/issues"
},
"split_keywords": [
"util",
" utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a7dc2a1e35e2ce85ada7470dfe35e0ff4489c2f79e57fe52c4d892474f1140e",
"md5": "93757bafab670fbbf2f68bf5b95d74da",
"sha256": "b49d3612a2f794dafc7d41a0c5ee20710759f0d331a39f14cf18f44bddeb3dd6"
},
"downloads": -1,
"filename": "delayviewer-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93757bafab670fbbf2f68bf5b95d74da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7725,
"upload_time": "2024-10-07T01:32:50",
"upload_time_iso_8601": "2024-10-07T01:32:50.863693Z",
"url": "https://files.pythonhosted.org/packages/2a/7d/c2a1e35e2ce85ada7470dfe35e0ff4489c2f79e57fe52c4d892474f1140e/delayviewer-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d50ff9d445720c3b5479832930c8ee5875079cd5f83da3193aa619b430c08913",
"md5": "6d7de50e5cb72832e734d9febd10ab1b",
"sha256": "686327cca97077d79d8db2e678995d854e3c1e8d9ae23eeab2de9d36e9d01634"
},
"downloads": -1,
"filename": "delayviewer-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6d7de50e5cb72832e734d9febd10ab1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6897,
"upload_time": "2024-10-07T01:32:51",
"upload_time_iso_8601": "2024-10-07T01:32:51.840950Z",
"url": "https://files.pythonhosted.org/packages/d5/0f/f9d445720c3b5479832930c8ee5875079cd5f83da3193aa619b430c08913/delayviewer-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 01:32:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ew98",
"github_project": "delayviewer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "delayviewer"
}
