Initial commit

Author: Alvaro Muñoz

Makefile

@@ -0,0 +1,26 @@
+# Note: This is meant for codeql_kernel developer use only
+.PHONY: data-files build install clean test
+
+data-files: clean
+	mkdir -p jupyter-data/share/jupyter/kernels/codeql
+	cp codeql_kernel/kernel.json jupyter-data/share/jupyter/kernels/codeql
+	cp codeql_kernel/images/* jupyter-data/share/jupyter/kernels/codeql/
+
+install: data-files
+	python build_treesitter.py
+	pip install -e ".[test]"
+
+clean:
+	rm -rf jupyter-data
+	rm -rf build
+	rm -rf dist
+
+
+build: data-files
+	pip install build twine
+	python -m build .
+	twine check --strict dist/*
+
+test: clean
+	pytest
+	make clean

README.md

@@ -0,0 +1,51 @@
+# CodeQL kernel for Jupyter
+
+## Local Installation 
+
+To install from a git checkout, run:
+
+```bash
+$ pip install jupyter jupyterlab tree_sitter
+$ make install
+```
+
+Verify installation:
+
+Run `jupyter kernelspec list` and check that `codeql` is available as a Jupyter kernel:
+
+```bash
+$ jupyter kernelspec list      
+Available kernels:
+  codeql     /Users/pwntester/.pyenv/versions/3.8.13/share/jupyter/kernels/codeql
+  python3    /Users/pwntester/.pyenv/versions/3.8.13/share/jupyter/kernels/python3
+```
+
+# Highlight extension
+
+Jupyter-lab extension to highlight CodeQL syntax
+
+## Local Installation
+
+```bash
+cd jupyterlab-codeql-highlight
+npm install
+jupyter labextension link .
+```
+
+# Commands
+
+- `%set_database <CodeQL DB directory>`: Sets the Database for analysis.
+
+# Example
+
+```bash
+cd example
+jupyter-lab test.ipynb
+```
+
+Wait for each cell to run before running other cells.
+
+# Disclaimer
+
+This is an experimental project not maintained by the GitHub CodeQL teams.
+Any contributions are welcomed!

build_treesitter.py

@@ -0,0 +1,3 @@
+from tree_sitter import Language
+
+Language.build_library('codeql_kernel/tree-sitter-ql.so', ['vendor/tree-sitter-ql'])

codeql_kernel/__init__.py

@@ -0,0 +1,3 @@
+from .kernel import CodeQLKernel
+from .codeql import CLIClient, QueryClient
+from ._version import __version__

codeql_kernel/__main__.py

@@ -0,0 +1,4 @@
+from ipykernel.kernelapp import IPKernelApp
+from . import CodeQLKernel
+
+IPKernelApp.launch_instance(kernel_class=CodeQLKernel)