Skip to main content

real time logging via IPython

Project description

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:

pip install ipython-rtlogging

or download from https://github.com/wilmerwang/ipython-rtlogging and:

cd ipython-rtlogging
python3 setup.py install

Examples

Please cheack this notebook

Usage

Load rt_logging in IPython or IPython Notebook:

In [1]: %load_ext rt_logging

Then can use CLI to monitor the progress of a running code:

# Simaple usage
rt_logging

# OR Just list the running cell
rt_logging -ls

There are some extesion magic method:

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.

In [3]: %ls_logging?
Docstring:
::

    %ls_logging [--ll]

list the all logging names

optional arguments:
  --ll  File Name to Load

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

In [5]: %rm_logging?
Docstring:
::

  %rm_logging [--name NAME]

delete logging

optional arguments:
  --name NAME  File Name to Load

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipython-rtlogging-0.2.2.tar.gz (7.2 kB view hashes)

Uploaded Source

Built Distribution

ipython_rtlogging-0.2.2-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page