Skip to main content

vdk-ipython

Ipython extension for VDK

This extension introduces a magic command for Jupyter. The command enables the user to load job_input for his current data job and use it freely while working with Jupyter.

See more about magic commands: https://ipython.readthedocs.io/en/stable/interactive/magics.html

Usage

To use the extension it must be firstly installed with pip as a python package. Then to load the extension in Jupyter the user should use:

%reload_ext vdk_ipython

And to load the VDK (Job Control object):

%reload_VDK

The %reload_VDK magic can be used with arguments such as passing the job's path with --path or giving the job a new with --name, etc.

Example

The output of this example is "myjob"

%reload_ext vdk_ipython

%reload_VDK --name=myjob

job_input = VDK.get_initialized_job_input()

job_input.get_name()

Build and testing

pip install -r requirements.txt
pip install -e .
pytest

In VDK repo ../build-plugin.sh script can be used also.

Note about the CICD:

.plugin-ci.yaml is needed only for plugins part of Versatile Data Kit Plugin repo.

The CI/CD is separated in two stages, a build stage and a release stage. The build stage is made up of a few jobs, all which inherit from the same job configuration and only differ in the Python version they use (3.7, 3.8, 3.9, 3.10 and 3.11). They run according to rules, which are ordered in a way such that changes to a plugin's directory trigger the plugin CI, but changes to a different plugin does not.

Metadata

Release files for vdk-ipython 0.1.919227134

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vdk-ipython 0.1.919227134
File Size Uploaded
vdk-ipython-0.1.919227134.tar.gz 4.3 kB Details

Release files / vdk-ipython-0.1.919227134.tar.gz

Download URL vdk-ipython-0.1.919227134.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
01d20905e8696e762f3e3674aecda0157092f6d0b8ca09f7c09e7720f41a5b24
BLAKE2b-256 checksum
How to use checksums
0deff1e06769183568d7399bc248e4716c798663ea4b4a3f8817ba438a198484
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.11
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page