| Name | tqdme JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | Forward progress from tqdm to a public website |
| upload_time | 2024-05-23 19:49:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2024, Garrett Flynn All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
bar
meter
progress
progressbar
progressmeter
time
tqdm
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tqdme
## Environment Variables
- `TQDME_URL` - URL to the TQDME server. Default: `http://tqdm.me`
- `TQDME_DISPLAY` - Show TQDM progress bars in the terminal. Default: `True`
- `TQDME_VERBOSE` - Print debug messages. Default: `False`
## Usage
### tqdm Replacement
Use `tqdme` as a drop-in replacement for `tqdm` in your Python scripts.
```python
import time
# from tqdm import tqdm
from tqdme import tqdme
num_iterations = 100 # Define the number of iterations
for i in tqdme(range(num_iterations)):
time.sleep(0.1) # Sleep for 0.1 seconds
```
### Relay Server (Flask + SocketIO)
> **Note:** The `tqdme` server assumes you have provided an `index.html` file in the `base` directory.
```python
from tqdme.server import Server
from flask import send_from_directory
from pathlib import Path
script_directory = Path(__file__).parent.resolve()
server = Server(script_directory, 'localhost', 3768)
app = server.app
@server.app.route('/src/<path:path>')
def get_static_assets(path):
return send_from_directory(server.base / 'src', path)
server.run()
```
## Distrubution
```
python -m pip install --upgrade build
python -m pip install --upgrade twine
python -m build
python -m twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tqdme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "bar, meter, progress, progressbar, progressmeter, time, tqdm",
"author": null,
"author_email": "Garrett Flynn <garrettmflynn@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7c/3d/4479ddd8e485b56750be9a69461e73343442ba1f7b381c9f9f1e03823aa8/tqdme-0.0.3.tar.gz",
"platform": null,
"description": "# tqdme\n \n\n## Environment Variables\n- `TQDME_URL` - URL to the TQDME server. Default: `http://tqdm.me`\n- `TQDME_DISPLAY` - Show TQDM progress bars in the terminal. Default: `True`\n- `TQDME_VERBOSE` - Print debug messages. Default: `False`\n\n## Usage\n\n### tqdm Replacement\nUse `tqdme` as a drop-in replacement for `tqdm` in your Python scripts.\n```python\nimport time\n# from tqdm import tqdm\nfrom tqdme import tqdme\n\nnum_iterations = 100 # Define the number of iterations\n\nfor i in tqdme(range(num_iterations)):\n time.sleep(0.1) # Sleep for 0.1 seconds\n```\n\n### Relay Server (Flask + SocketIO)\n\n> **Note:** The `tqdme` server assumes you have provided an `index.html` file in the `base` directory. \n\n```python\nfrom tqdme.server import Server\nfrom flask import send_from_directory\nfrom pathlib import Path\n\nscript_directory = Path(__file__).parent.resolve()\n\nserver = Server(script_directory, 'localhost', 3768)\n\napp = server.app\n\n@server.app.route('/src/<path:path>')\ndef get_static_assets(path):\n return send_from_directory(server.base / 'src', path)\n\nserver.run()\n```\n\n\n## Distrubution\n```\npython -m pip install --upgrade build\npython -m pip install --upgrade twine\npython -m build\npython -m twine upload dist/*\n```",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Garrett Flynn All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Forward progress from tqdm to a public website",
"version": "0.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/tqdme/tqdme/issues",
"Homepage": "https://github.com/tqdme/tqdme"
},
"split_keywords": [
"bar",
" meter",
" progress",
" progressbar",
" progressmeter",
" time",
" tqdm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7fad47b1dea46af1571fa3c276599af1b5c68a493725bead0fa54678464637a0",
"md5": "9f7021153eb2d1a8fac1a622890208ed",
"sha256": "751c7c03958063b74d32ff773f64169e8af984c0fb6b5047bb4501692559b22e"
},
"downloads": -1,
"filename": "tqdme-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9f7021153eb2d1a8fac1a622890208ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6625,
"upload_time": "2024-05-23T19:49:52",
"upload_time_iso_8601": "2024-05-23T19:49:52.244758Z",
"url": "https://files.pythonhosted.org/packages/7f/ad/47b1dea46af1571fa3c276599af1b5c68a493725bead0fa54678464637a0/tqdme-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c3d4479ddd8e485b56750be9a69461e73343442ba1f7b381c9f9f1e03823aa8",
"md5": "68576b497d8932df306109d7d9e8a0a7",
"sha256": "360a626c768a862fe383da1becc49457258251d77edfa1bf78d5022d305331ef"
},
"downloads": -1,
"filename": "tqdme-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "68576b497d8932df306109d7d9e8a0a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8009,
"upload_time": "2024-05-23T19:49:53",
"upload_time_iso_8601": "2024-05-23T19:49:53.448724Z",
"url": "https://files.pythonhosted.org/packages/7c/3d/4479ddd8e485b56750be9a69461e73343442ba1f7b381c9f9f1e03823aa8/tqdme-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-23 19:49:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tqdme",
"github_project": "tqdme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tqdme"
}
