Skip to content

uqbar-project/wollok-jupyter-kernel

Repository files navigation

Python package

Wollok Jupyter Logo

Wollok Kernel for Jupyter notebook

wollok_kernel is a Jupyter kernel implementation, started from a wrapper kernel.

Wollok Kernel Demo

💻 Installation

Pre-requisites

You need to install Python (3.7 or newer). If you don't have Python, the recommended option is installing it using the official site, and click on Download Python X.X.X (there a different options depending on your operating system).

python --version

If python3 --version works, you should use an alias or replace python with python3.

Install Conda environment manager. Follow the instructions for your operating system.

Install Node & npm tools.

Wollok Kernel

Clone this repository:

git clone https://github.com/uqbar-project/wollok-jupyter-kernel # you can also use git@... option

Install Wollok Jupyter Kernel:

cd ./wollok-jupyter-kernel
conda init
./install_kernel.sh

At the end of the script you should see an output similar to the following:

Available kernels:
  python3    /path/to/venv/lib/python3.13/site-packages/ipykernel/resources
  wollok     /path/to/wollok-jupyter-kernel/venv/share/jupyter/kernels/wollok

If you need you can uninstall the kernel by running

./uninstall_kernel.sh

VSCode

Install Jupyter extension in VSCode:

  • Open Extension Tab (⇧⌘X or Ctrl+Shift+X)
  • Look for "Jupyter"
  • (Recommended) Install Wollok LSP extension
  • Install Microsoft official extension

Install VSCode extension

Then you can create a New File... > Jupyter Notebook

New Jupyter Notebook File

And select kernel: click on the Kernel link at the right side > Select another kernel > Jupyter Kernel > Wollok:

demoWollokJupyter

Make sure you don't select Python Environment because this will expect a Python kernel, not a Wollok kernel.

👩‍💻 Contribution

🦄 Using Wollok kernel

  • Notebook: The New menu in the notebook should show an option for a Wollok notebook.
  • Console frontends: To use it with the console frontends, add --kernel wollok to their command line arguments.

☁️ Using Wollok Kernel online

You can use this project as an example on how to use the Wollok kernel in MyBinder site, a Jupyter Notebook environment in the cloud. It will use the latest stable version of the Wollok kernel based on PyPI repository.

Click on the Launch binder icon, wait for the environment to be ready, and you should see a Jupyter notebook with the Wollok kernel selected.

Powered by Uqbar

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published