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
%%vdksqlmagic and tagged with "vdk" - VDK Ingest Cell. Those are celles marked with
%%vdkingestmagic.
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.
1 maintainer
Metadata
1 maintainer
Release files for vdk-notebook 0.1.1184833162
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vdk-notebook-0.1.1184833162.tar.gz | 7.6 kB | Details |
Release files / vdk-notebook-0.1.1184833162.tar.gz
| Download URL | vdk-notebook-0.1.1184833162.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
79eea1dab1d8c6fceab9e05880f58aacb92706092632ee6a3a61ec7eaeb664be
|
|
BLAKE2b-256 checksum How to use checksums |
dfd8cebddfd56fa2bf11cd9418564b95dbbd88fafa58a7c945f159afcf71b72e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.13
|
