Skip to main content

Python package with widget to simplify work with many processes in jupyter

Project description

GitHub last commit GitHub license<space><space> https://travis-ci.org/stas-prokopiev/jupyter_process_manager.svg?branch=master PyPI PyPI - Python Version

Overview.

This is a library which helps working with many processes in a jupyter notebook in a very simple way.

Installation via pip:

pip install jupyter_process_manager

Usage examples

How to create create and start processes for jupyter_process_manager

from jupyter_process_manager import JupyterProcessManager
process_manager = JupyterProcessManager(".")  # "." - path where to store outputs of the processes

# And functions for processing
process_manager.add_function_to_processing(
    func1, *func1_args,**func1_kwargs)
process_manager.add_function_to_processing(
    func2, *func2_args,**func2_kwargs)

WARNING: Please do NOT try to use functions defined inside jupyter notebook, they won’t work.

JupyterProcessManager arguments:

  1. str_dir_for_output: Directory where to store processes outputs

  2. is_to_delete_previous_outputs=True: Flag If you want to delete outputs for all previous processes in the directory

Usage in Jupyter Notebook

After processes were added, you can check what is happening with them.

process_manager

Showing the JupyterProcessManager widget won’t block execution so you can run the code in other cells

images/2.PNG

How to check output for the processes

Select the process for which you want to see the output.
Select which output you want to see.
The output will get updated every 2 seconds.

How to add more processes

You can add as many processes as you want
by running the code below in any other jupyter notebook cell
process_manager.add_function_to_processing(
    func_new, *func_new_args,**func_new_kwargs)

How to stop a process

To stop the process, select it and press the orange button to stop it

When the button to stop the selected process is pushed.
KeyboardInterrupt Exception is called for the process
If within 5 seconds process is not finished then the process will be killed.

How to do a debug run without a new process creation

# arguments are the same as in **add_function_to_processing(...)**
process_manager.debug_run_of_1_function(func_to_process, *args, **kwargs)

Other methods available within running processes for JPM

Clear stdout output from the process

from jupyter_process_manager import clear_output
clear_output()

Get stdout output for the process

from jupyter_process_manager import read_stdout
stdout_content = read_stdout()

Usage in a console

process_manager.wait_till_all_processes_are_over()

You will see the output like shown below

images/1.PNG

Contacts

License

This project is licensed under the MIT License.

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

jupyter_process_manager-0.1.21.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

jupyter_process_manager-0.1.21-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_process_manager-0.1.21.tar.gz.

File metadata

  • Download URL: jupyter_process_manager-0.1.21.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.12 Windows/10

File hashes

Hashes for jupyter_process_manager-0.1.21.tar.gz
Algorithm Hash digest
SHA256 e179fe215cf697f8a079ba958f8e059e899448a581b10ceb9b327d01c0a9b25e
MD5 1e74f07bfac8271f2c50ba86e4d41f7b
BLAKE2b-256 11c72d938f477af2346c17f4f50680ae0bdd963c87359a3c0d78a689158e2301

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_process_manager-0.1.21-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_process_manager-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 f94f52e31d4d9057df3c83f6f1d9ee85772ebe4b19375335302ec0f53fa4f5a5
MD5 096a8b4c67fb1a3f53ee43231cae53b8
BLAKE2b-256 d673e94c31fc6e74eac034943278df21bb2384cc361e2cc14e40aa617fe9d0b6

See more details on using hashes here.

Provenance

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