Skip to main content

A VDK plugin for working with notebooks

Project description

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

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.

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

vdk-notebook-0.1.779502828.tar.gz (5.2 kB view details)

Uploaded Source

File details

Details for the file vdk-notebook-0.1.779502828.tar.gz.

File metadata

  • Download URL: vdk-notebook-0.1.779502828.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.15

File hashes

Hashes for vdk-notebook-0.1.779502828.tar.gz
Algorithm Hash digest
SHA256 8ab95789a4a5582d4f0847301a34661e4eccfbc29a7608eba981006b6b1a0c04
MD5 cab9d7372ac77e50aeb55a39eea98ddf
BLAKE2b-256 cb6bb229a6180b2b42911a24e978d45dcf3ee4ce0374db92b1c4949c9a1376a9

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