rennips

Name	rennips JSON
Version	0.2.0 JSON
	download
home_page	https://github.com/Oh-JongJin/rennips
Summary	A minimalist Python progress spinner for iterative processes
upload_time	2024-10-31 12:05:59
maintainer	None
docs_url	None
author	Oh Jongjin
requires_python	>=3.7
license	MIT License Copyright (c) 2024 Oh Jongjin (5jx2oh@gmail.com) 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	progress spinner progress-bar cli
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # rennips

A minimalist Python progress **spinner** that provides a simple visual feedback for iterative processes with normal and simple display modes.

\> "*rennips*" is simply 'spinner' spelled backwards. 

Check out on [**PyPI**](https://pypi.org/project/rennips/0.1.0/)



## Installation

```bash
pip install rennips
```



## Usage

```python
import time
from rennips import rennips


data = [x for x in range(50)]
for i in rennips(data, desc="Counting...", mode="SIMPLE"):
    time.sleep(0.05)
```



## Features

- Simple spinner animation (**|, /, -, \\**)
- Progress percentage
- Item count
- Elapsed time
- Works with any iterable
- Support for iterables without known length



## Roadmap

Future features and improvements planned for Rennips:

### Short-term Goals
- [ ] Big mode: Large-scale spinner display for better visibility in terminal
- [ ] Manual spinner control: Support for non-iterable progress tracking, allowing start/stop/update operations

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Oh-JongJin/rennips",
    "name": "rennips",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "progress, spinner, progress-bar, cli",
    "author": "Oh Jongjin",
    "author_email": "Oh Jongjin <5jx2oh@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/82/c7/d3451cda6511b821ee4f406573a80fdbd772dcb7e6f0d46f50109ef5afba/rennips-0.2.0.tar.gz",
    "platform": null,
    "description": "# rennips\r\n\r\nA minimalist Python progress **spinner** that provides a simple visual feedback for iterative processes with normal and simple display modes.\r\n\r\n\\> \"*rennips*\" is simply 'spinner' spelled backwards. \r\n\r\nCheck out on [**PyPI**](https://pypi.org/project/rennips/0.1.0/)\r\n\r\n\r\n\r\n## Installation\r\n\r\n```bash\r\npip install rennips\r\n```\r\n\r\n\r\n\r\n## Usage\r\n\r\n```python\r\nimport time\r\nfrom rennips import rennips\r\n\r\n\r\ndata = [x for x in range(50)]\r\nfor i in rennips(data, desc=\"Counting...\", mode=\"SIMPLE\"):\r\n    time.sleep(0.05)\r\n```\r\n\r\n\r\n\r\n## Features\r\n\r\n- Simple spinner animation (**|, /, -, \\\\**)\r\n- Progress percentage\r\n- Item count\r\n- Elapsed time\r\n- Works with any iterable\r\n- Support for iterables without known length\r\n\r\n\r\n\r\n## Roadmap\r\n\r\nFuture features and improvements planned for Rennips:\r\n\r\n### Short-term Goals\r\n- [ ] Big mode: Large-scale spinner display for better visibility in terminal\r\n- [ ] Manual spinner control: Support for non-iterable progress tracking, allowing start/stop/update operations\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Oh Jongjin (5jx2oh@gmail.com)  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": "A minimalist Python progress spinner for iterative processes",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/Oh-JongJin/rennips"
    },
    "split_keywords": [
        "progress",
        " spinner",
        " progress-bar",
        " cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe777324b8751eb5dc5cabafaa8a722a2e7914b63db82e9e370f1acc06af9f5d",
                "md5": "f9d367a6ede0fa8c556aa115d639e9c5",
                "sha256": "7e9bcfb89912f6f4a7a020104399986269149e32d1509e10893dc54f4d147a79"
            },
            "downloads": -1,
            "filename": "rennips-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f9d367a6ede0fa8c556aa115d639e9c5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4679,
            "upload_time": "2024-10-31T12:05:57",
            "upload_time_iso_8601": "2024-10-31T12:05:57.729225Z",
            "url": "https://files.pythonhosted.org/packages/fe/77/7324b8751eb5dc5cabafaa8a722a2e7914b63db82e9e370f1acc06af9f5d/rennips-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "82c7d3451cda6511b821ee4f406573a80fdbd772dcb7e6f0d46f50109ef5afba",
                "md5": "2a69594832b27e83bfb24ca387a60246",
                "sha256": "94d0b338eabdeec04822c6341ea589bbe9c63bd9dbefc7dc39d96f7f435a1a39"
            },
            "downloads": -1,
            "filename": "rennips-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2a69594832b27e83bfb24ca387a60246",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4217,
            "upload_time": "2024-10-31T12:05:59",
            "upload_time_iso_8601": "2024-10-31T12:05:59.260456Z",
            "url": "https://files.pythonhosted.org/packages/82/c7/d3451cda6511b821ee4f406573a80fdbd772dcb7e6f0d46f50109ef5afba/rennips-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-31 12:05:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Oh-JongJin",
    "github_project": "rennips",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "rennips"
}