vdk-notebook 0.1.1190994517

A VDK plugin for working with notebooks

vdk-notebook

A new VDK plugin which supports running data jobs which consists of .ipynb files. You can see VDK Jupyter Integration VEP for more information.

Usage

To install the plugin you need to run:

pip install vdk-notebook

Configuration

No specific notebook configurations are needed currently.

Example

Here is a directory structure which consist of one parent directory "parent-dir" and two subdirectories. One of the subdirectories is a data job("example-job"). This is how the structure looks like:

parent-dir
└── example-job
    ├── notebook.ipynb
    ├── requirements.txt
    └── config.ini
└── some-other-dir

To run the data job from the parent-dir we need to use:

vdk run example-job

• Each cell which has tag "vdk" is executed
• There could be those types of VDK Cells:
  • VDK Python Cell. Those are normal Python cells tagged with "vdk"
  • VDK SQL Cell. Those are cells marked with %%vdksql magic and tagged with "vdk"
  • VDK Ingest Cell. Those are celles marked with %%vdkingest magic.

For more information and examples see vdk-ipython documentation

Testing

Testing this plugin locally requires installing the dependencies listed in vdk-plugins/vdk-notebook/requirements.txt

Run

pip install -r requirements.txt

Architecture

See the architecture of the plugin in the "Detailed design" section of the VEP.