Skip to main content

Kestrel Jupyter Kernel

Project description

Python 3 Code Style: Black Code Coverage Latest Version

This repository contains two Python packages:

  • kestrel_jupyter_kernel

  • kestrel_ipython

Install and Setup

To install the released version:

$ pip install kestrel-jupyter
$ python -m kestrel_jupyter_kernel.setup

To install the nightly built version:

$ git clone git://github.com/opencybersecurityalliance/kestrel-jupyter
$ cd kestrel-jupyter
$ pip install .
$ python -m kestrel_jupyter_kernel.setup

How to Use Kestrel Jupyter Notebook Kernel

Start Jupyter with jupyter nbclassic and start a new notebook with the kestrel kernel. Note if you are using jupyter lab, most functionalities are there such as code execution, error prompot, and context-aware auto-complete, but the syntax highlighting is not ported from our Jupyter Notebook environment to Jupyter Lab yet.

Write your hello world hunt:

newvar = NEW process ["cmd.exe", "reg.exe"]
DISP newvar

Check Kestrel documentation for more.

How to Use ipython Magic Function

import kestrel_ipython

Then you can write any code in single-line or multi-line Kestrel in Python:

%%kestrel
newvar = NEW process ["cmd.exe", "reg.exe"]
DISP newvar

Uninstall Kestrel Jupyter Kernel

List all Jupyter kernels installed:

$ jupyter kernelspec list

Uninstall Kestrel kernel:

$ jupyter kernelspec uninstall kestrel

How to Contribute

As a component in the Kestrel runtime, this repo follows the contributing guideline and governance documentation in the main kestrel-lang repo.

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

kestrel-jupyter-1.0.7.tar.gz (10.4 kB view hashes)

Uploaded source

Built Distribution

kestrel_jupyter-1.0.7-py3-none-any.whl (12.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page