jupyter-datainputtable 0.7.1rc2

Predefined data input tables for Jupyter notebooks

jupyter-datainputtable

Tools for generating predefined data input tables for use in Jupyter notebooks. This is primarily for student worksheets.

Current Features:

• Can create a table using a python command in the Jupyter notebook.
• If using JupyterPhysSciLab/JupyterPiDAQ or JupyterPhysSciLab/InstructorTools tables can be created using menu items in the Jupyter notebook (recommended usage).
• Table column and row labels can be locked once set.
• Number of rows and columns must be chosen on initial creation.
• Table will survive deletion of all cell output data.
• Default setting is to make the code cell that creates the table uneditable and undeletable.
• Table creation code will work without this package installed in the Jupyter kernel. Tables are viewable, but not editable in a plain vanilla Jupyter install.
• Option to create Pandas DataFrame from the table if Pandas imported as pd. If user tries without Pandas an explanation is provided. Versions >=0.7.0 properly handle cells that are empty or contain text.

Wishlist:

• Add rows to existing table.

Installation

Installation using pip into a virtual environment is recommended.

Production

1. If not installed, install pipenv:$ pip3 install --user pipenv. You may need to add ~/.local/bin to your PATH to make pipenv available in your command shell. More discussion: The Hitchhiker's Guide to Python.

2. Navigate to the directory where this package will be installed.

3. Start a shell in the environment $ pipenv shell.

4. Install using pip.

   1. $ pip install jupyter-datainputtable. This will install Jupyter into the same virtual environment if you do not already have it on your machine. If Jupyter is already installed the virtual environment will use the existing installation. This takes a long time on a Raspberry Pi. It will not run on a 3B+ without at least 1 GB of swap. See: Build Jupyter on a Pi.
   2. Still within the environment shell test this by starting jupyter $ jupyter notebook. Jupyter should launch in your browser.
      1. Open a new notebook using the default (Python 3) kernel.
      2. In the first cell import the input_table module: from input_table import *
      3. To try use the command create_input_table() in the next cell. This should generate a blank code cell and another code cell that has a table in the output for you to define your table dimensions.
      4. If you define the dimensions the input table will be created for you.

5. Optional You can make this environment available to an alternate Jupyter install as a special kernel when you are the user.

   1. Make sure you are running in your virtual environment $ pipenv shell in the directory for virtual environment will do that.
   2. Issue the command to add this as a kernel to your personal space: $ python -m ipykernel install --user --name=<name-you-want-for-kernel>.
   3. More information is available in the Jupyter/Ipython documentation. A simple tutorial from Nikolai Jankiev (Parametric Thoughts) can be found here.

Development

Simply replace $ pip install jupyter-datainputtable with $ pip install -e jupyter-datainputtable in the Production instructions.

Issues or comments

JupyterPhysSciLab/jupyter-datainputtable