Skip to main content

A VDK plugin for working with notebooks

Project description

vdk-notebook

monthly download count for 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.

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.1190994517.tar.gz (7.7 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: vdk-notebook-0.1.1190994517.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for vdk-notebook-0.1.1190994517.tar.gz
Algorithm Hash digest
SHA256 c1034641059fb37d036f9dc6f76ec3b020817fd71c03b2cee676a10bfc55270f
MD5 98e38056a2f36159c6d22138aeaf0092
BLAKE2b-256 af60d920f46dbeb2d3ec2be4903f79eb3186139cb6a0ed81797503dd7367aa1f

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