README.md

cairo_jupyter

cairo_jupyter hosts notebooks and code for cairo-kernel its a simple Jupyter kernel for Cairo a smart contract programing language for STARKs.

Hosted on binder:

Project managenemt: Kanban

Installation

1. Install virtualenv

   virtualenv -p python3.8 venv
   source venv/bin/activate
   

2. To install cairo_kernel:

   # Upgrade to latest version of setuptools and wheel
   pip install -U setuptools
   pip install -U wheel
   pip install cairo-kernel
   

Using the Kernel

Cairo example is a working example of the notebook.

Notebook: The New menu in the notebook should show an option for an Cairo notebook.

Console frontends: To use it with the console frontends, add --kernel cairo to their command line arguments.

Running the kernel on notebook

1. Start the notebook

   jupyter notebook
   

2. Start cairo kernel via UI

Development

1. Clone & enter the repo.

    git clone https://github.com/ankitchiplunkar/cairo-jupyter.git

2. Install required libraries.

    pip install -r requirements.txt

3. Install the cairo-jupyter library locally:

    pip install -e .
    python -m cairo_kernel.install