looptimer


Namelooptimer JSON
Version 1.1.0 PyPI version JSON
download
home_page
Summary
upload_time2023-02-11 19:42:52
maintainer
docs_urlNone
author
requires_python>=2.7
licenseThe MIT License (MIT) Copyright (c) 2015 Bryan Johnson 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.
keywords timer timing progress
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # looptimer

Progress bar style loop timer with projected time-to-completion.

[![License](https://img.shields.io/github/license/dbjohnson/looptimer.svg)]()
[![PyPi](https://img.shields.io/pypi/v/looptimer.svg)](https://pypi.python.org/pypi/looptimer)
![GHA](https://github.com/dbjohnson/looptimer/actions/workflows/main.yml/badge.svg)

## Installation
```pip install looptimer```

## Usage
Directly wrap any iterable with `timedloop` to get iteration progress status:

```python
from looptimer import timedloop

for _ in timedloop(range(100), label='foo'):
	...
```

### Sample output
![](demo.gif)

### Optional arguments

Argument|Type|Default|Description
--------|----|-------|-----------
`label`|str|None|Descriptive label printed to the left of the progress bar
`bar_char`|str|▢|Character used to fill in the progress bar
`bar_width`|int|20|Character width of the progress bar
`animate`|bool|True|Disable to print each update on a new line (useful when interspersed with other log messages)
`max_refresh_secs`|float|0.1|Use to throttle print frequency for fast-iterating loops


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "looptimer",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7",
    "maintainer_email": "",
    "keywords": "timer,timing,progress",
    "author": "",
    "author_email": "Bryan Johnson <d.bryan.johnson@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/cc/5c/1f5775bc1e021aae1c9b164feae1dbcf7bff8fda44c5dd9cac29a6a7fbd2/looptimer-1.1.0.tar.gz",
    "platform": null,
    "description": "# looptimer\n\nProgress bar style loop timer with projected time-to-completion.\n\n[![License](https://img.shields.io/github/license/dbjohnson/looptimer.svg)]()\n[![PyPi](https://img.shields.io/pypi/v/looptimer.svg)](https://pypi.python.org/pypi/looptimer)\n![GHA](https://github.com/dbjohnson/looptimer/actions/workflows/main.yml/badge.svg)\n\n## Installation\n```pip install looptimer```\n\n## Usage\nDirectly wrap any iterable with `timedloop` to get iteration progress status:\n\n```python\nfrom looptimer import timedloop\n\nfor _ in timedloop(range(100), label='foo'):\n\t...\n```\n\n### Sample output\n![](demo.gif)\n\n### Optional arguments\n\nArgument|Type|Default|Description\n--------|----|-------|-----------\n`label`|str|None|Descriptive label printed to the left of the progress bar\n`bar_char`|str|\u25a2|Character used to fill in the progress bar\n`bar_width`|int|20|Character width of the progress bar\n`animate`|bool|True|Disable to print each update on a new line (useful when interspersed with other log messages)\n`max_refresh_secs`|float|0.1|Use to throttle print frequency for fast-iterating loops\n\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2015 Bryan Johnson  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.  ",
    "summary": "",
    "version": "1.1.0",
    "split_keywords": [
        "timer",
        "timing",
        "progress"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38f65acbe821d0ba6741a798e9f6ebad21a33b730255076d0d090d49d38d7fb6",
                "md5": "8e8a871be64f5de358614b153e3e5c8d",
                "sha256": "35bb432a6c3ef6488cf4de8c86456eb9fbb77a71a541208a4e5edd9cf9b9485b"
            },
            "downloads": -1,
            "filename": "looptimer-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8e8a871be64f5de358614b153e3e5c8d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=2.7",
            "size": 5175,
            "upload_time": "2023-02-11T19:42:51",
            "upload_time_iso_8601": "2023-02-11T19:42:51.021875Z",
            "url": "https://files.pythonhosted.org/packages/38/f6/5acbe821d0ba6741a798e9f6ebad21a33b730255076d0d090d49d38d7fb6/looptimer-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cc5c1f5775bc1e021aae1c9b164feae1dbcf7bff8fda44c5dd9cac29a6a7fbd2",
                "md5": "90b0166dc10a19eb38b8e053d4ced1d0",
                "sha256": "63222f3e1da3c70cc219ea701c371f87183cde0b7a0bb0e6091737983a5c338e"
            },
            "downloads": -1,
            "filename": "looptimer-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "90b0166dc10a19eb38b8e053d4ced1d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7",
            "size": 4690,
            "upload_time": "2023-02-11T19:42:52",
            "upload_time_iso_8601": "2023-02-11T19:42:52.802905Z",
            "url": "https://files.pythonhosted.org/packages/cc/5c/1f5775bc1e021aae1c9b164feae1dbcf7bff8fda44c5dd9cac29a6a7fbd2/looptimer-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-11 19:42:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "looptimer"
}
        
Elapsed time: 0.66245s