# ipython-rtlogging
## Ipython Real Time Logging
`ipython-rtlogging` is a tool that relies only on the Python standard library (except for IPython, Rich) and is used to capture and log the output streams of cells in real-time within IPython or IPython Notebook. It provides an optional solution to tackle the problem of losing cell outputs or not being able to monitor the progress of a running code after reconnecting to the Notebook.
https://github.com/wilmerwang/ipython-rtlogging/assets/35020700/be3fa6e5-0d77-415b-a888-a3f70d1a7c12
## Dependencies
- ipython
- rich
## Install
Install the latest release with:
```bash
pip install ipython-rtlogging
```
or download from [https://github.com/wilmerwang/ipython-rtlogging](https://github.com/wilmerwang/ipython-rtlogging) and:
```bash
cd ipython-rtlogging
python3 setup.py install
```
## Examples
Please cheack [this notebook](doc/doc.ipynb)
## Usage
Load rt_logging in IPython or IPython Notebook:
```bash
In [1]: %load_ext rt_logging
```
---
Then can use CLI to monitor the progress of a running code:
```bash
# Simaple usage
rt_logging
# OR Just list the running cell
rt_logging -ls
```
---
There are some extesion magic method:
```bash
In [2]: %%rt_logging?
Docstring:
::
%rt_logging [--no-stderr] [--no-stdout] [name] [buffering]
run the cell, print and redirect stdout, stderr calls.
positional arguments:
name File Name
buffering buffering size, 1 to select line buffering. Same as
open(buffering)
optional arguments:
--no-stderr Dont capture stderr.
--no-stdout Dont capture stdout.
```
---
```bash
In [3]: %ls_logging?
Docstring:
::
%ls_logging [--ll]
list the all logging names
optional arguments:
--ll File Name to Load
```
---
```bash
In [4]: %load_logging?
Docstring:
::
%load_logging [--name NAME] [--top TOP]
load and print logging data
optional arguments:
--name NAME File Names to Load
--top TOP top lines to Load
```
---
```bash
In [5]: %rm_logging?
Docstring:
::
%rm_logging [--name NAME]
delete logging
optional arguments:
--name NAME File Name to Load
```
## License
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/wilmerwang/ipython-rtlogging",
"name": "ipython-rtlogging",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "logging ipython real-time reconnection",
"author": "wilmerwang",
"author_email": "280458666@qq.com",
"download_url": "https://files.pythonhosted.org/packages/19/a6/0814c361ba3f8a10b6c4a0ecb7224696db72c8fb28aa6b8283a2d3d80a36/ipython-rtlogging-0.2.2.tar.gz",
"platform": null,
"description": "# ipython-rtlogging\n## Ipython Real Time Logging\n`ipython-rtlogging` is a tool that relies only on the Python standard library (except for IPython, Rich) and is used to capture and log the output streams of cells in real-time within IPython or IPython Notebook. It provides an optional solution to tackle the problem of losing cell outputs or not being able to monitor the progress of a running code after reconnecting to the Notebook.\n\n\nhttps://github.com/wilmerwang/ipython-rtlogging/assets/35020700/be3fa6e5-0d77-415b-a888-a3f70d1a7c12\n\n\n\n\n\n\n\n\n\n## Dependencies\n- ipython\n- rich\n\n## Install\nInstall the latest release with:\n```bash\npip install ipython-rtlogging\n```\n\nor download from [https://github.com/wilmerwang/ipython-rtlogging](https://github.com/wilmerwang/ipython-rtlogging) and:\n```bash\ncd ipython-rtlogging\npython3 setup.py install\n```\n## Examples\nPlease cheack [this notebook](doc/doc.ipynb)\n\n## Usage\nLoad rt_logging in IPython or IPython Notebook: \n```bash\nIn [1]: %load_ext rt_logging\n```\n\n---\n\nThen can use CLI to monitor the progress of a running code:\n```bash\n# Simaple usage\nrt_logging\n\n# OR Just list the running cell\nrt_logging -ls\n```\n\n---\n\nThere are some extesion magic method:\n```bash\nIn [2]: %%rt_logging?\n\nDocstring:\n::\n\n %rt_logging [--no-stderr] [--no-stdout] [name] [buffering]\n\nrun the cell, print and redirect stdout, stderr calls.\n\npositional arguments:\n name File Name\n buffering buffering size, 1 to select line buffering. Same as\n open(buffering)\n\noptional arguments:\n --no-stderr Dont capture stderr.\n --no-stdout Dont capture stdout.\n```\n\n---\n\n```bash\nIn [3]: %ls_logging?\nDocstring:\n::\n\n %ls_logging [--ll]\n\nlist the all logging names\n\noptional arguments:\n --ll File Name to Load\n```\n---\n\n```bash\nIn [4]: %load_logging?\nDocstring:\n::\n\n %load_logging [--name NAME] [--top TOP]\n\nload and print logging data\n\noptional arguments:\n --name NAME File Names to Load\n --top TOP top lines to Load\n```\n\n---\n\n```bash\nIn [5]: %rm_logging?\nDocstring:\n::\n\n %rm_logging [--name NAME]\n\ndelete logging\n\noptional arguments:\n --name NAME File Name to Load\n```\n\n## License\nMIT\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "real time logging via IPython",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/wilmerwang/ipython-rtlogging"
},
"split_keywords": [
"logging",
"ipython",
"real-time",
"reconnection"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a64cd0b1bd0caf17bfc1c48e022be47809876d7069b282b35019cfd8b6ceeedc",
"md5": "a01d4985097794be2bca4c93df9ad519",
"sha256": "38475828cc0a6ae32e31d44bfcd4201aeae2ad48c9dfcad279da22a002b90851"
},
"downloads": -1,
"filename": "ipython_rtlogging-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a01d4985097794be2bca4c93df9ad519",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8886,
"upload_time": "2023-11-21T08:46:51",
"upload_time_iso_8601": "2023-11-21T08:46:51.354560Z",
"url": "https://files.pythonhosted.org/packages/a6/4c/d0b1bd0caf17bfc1c48e022be47809876d7069b282b35019cfd8b6ceeedc/ipython_rtlogging-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "19a60814c361ba3f8a10b6c4a0ecb7224696db72c8fb28aa6b8283a2d3d80a36",
"md5": "6d2cd390027965c7c342b84be87e2136",
"sha256": "f046d66df96f0a0080cf2da826f6e9a5c384e6f5d5361b2e49701c00fee594e9"
},
"downloads": -1,
"filename": "ipython-rtlogging-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "6d2cd390027965c7c342b84be87e2136",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7232,
"upload_time": "2023-11-21T08:46:54",
"upload_time_iso_8601": "2023-11-21T08:46:54.194215Z",
"url": "https://files.pythonhosted.org/packages/19/a6/0814c361ba3f8a10b6c4a0ecb7224696db72c8fb28aa6b8283a2d3d80a36/ipython-rtlogging-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 08:46:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wilmerwang",
"github_project": "ipython-rtlogging",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ipython-rtlogging"
}
JSON
