Kestrel Jupyter Kernel
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kestrel_jupyter-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f5edc47f47ebefe0721d385c759b326354bd50e38d8945989eb1dc4892e613a |
|
MD5 | 54c958effd446f73fe348abbf80a35fd |
|
BLAKE2b-256 | 80e690d80a95e8c5eaf8b4ccfa9f11a86b0f7af390d7a45417fdd0da682e447e |