Welcome to Jupyter Boxes’s documentation!

Jupyter Boxes is a framework that allows a user to create a drag and drop workflow utilizing Jupyter notebook cells. The framework is build on top of React Flow. A user will add comments to the beginning of a cell that will tell the framework how to convert it into a usable block. The framwork is composed a back-end/front-end (port 9494). The backend deployed contains the code for the frontend and the parsing code for the backend. File watcher looks at the notebook directory to put new notebooks to be processed automatically. Once processed, the notebook is not looked at again (unless db reset). The processed information get stored into a file called db.json. This file contians all the blocks to display.

Getting Started

• Installation
• JBox commands
  • jbox_build
  • jbox_reset_db
  • jbox_start
  • jbox_start_back_end
  • jbox_start_back_end_celery
  • jbox_paths
• How to start
  • Celery/RabbitMQ
  • Thread backend

Notebook Conversion

• Convert a notebook for JBox
• Installing Packages
• Importing Code and libraries
• Cell Conversion
  • Cell with no inputs and outputs
  • Cell with inputs and outputs
  • Defined function block
• Example Notebook

Standalone Backend

• Using the Standalone Backend
• Endpoints Available in JBox
  • /jbox_rest (GET)
  • /jbox_rest/upload_notebook (POST)
    • Output Format
  • /jbox_rest/input_upload_file (POST)
    • Output Format
  • /jbox_rest/execute_box (POST)
    • Output Format
  • /jbox_rest/task_status (POST)
    • Output Format

Configuring JBox Backend

• Configuring JBox Backend
• Adding new endpoints
• Adding Configs to Flask
• Configuring celery