Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 2.62 KB

README.md

File metadata and controls

70 lines (49 loc) · 2.62 KB
Raw

lein-jupyter

A Leiningen plugin to integrate with jupyter notebook and JupyterLab.

jupiter Clojars Project Build Status

Features

  • Per project kernel!
  • Parinfer integration! Check out the new parinfer button in the menu bar (jupyter notebook only).
  • Made with love

How to use?

Dependencies

You will need to have leiningen and jupyter notebook installed globally. The development has been done under ubuntu linux with jupyter 4.3.0.

JupyterLab is a separate install which will need to be performed to use the lein jupyter lab command.

Installation

  1. lein-jupyter is a simple leiningen plugin. Hence you can add the [lein-jupyter "0.1.16"] vector in your :plugins list in your project.clj. A simple project.clj might look like

    (defproject my-project "0.1.0-SNAPSHOT"
  :description "FIXME: write description"
  :url "http://example.com/FIXME"
  :license {:name "Eclipse Public License"
            :url "http://www.eclipse.org/legal/epl-v10.html"}
  :dependencies [[org.clojure/clojure "1.9.0"]]
  :main ^:skip-aot my-project.core
  :target-path "target/%s"
  :plugins [[lein-jupyter "0.1.16"]]
  :profiles {:uberjar {:aot :all}})

  2. The first time you use lein-jupyter, you will need to install the kernel. lein jupyter install-kernel is the command you need to run to install the kernel. You should run the command once but nothing wrong should happen if you run it more than once.

Customization

All options can be set in the :jupyter-options section of your project.clj's defproject. Bellow is the option list

Option Name Description Example
:jupyter-path the jupyter binary to use /home/ubuntu/anaconda3/bin/jupyter

Using lein-jupyter

The main command line entry is lein jupyter. The first time you use lein-jupyter, you will need to install the jupyter kernel using the lein jupyter install-kernel command. Then, you can use the lein jupyter notebook to run the jupyter notebook, or lein jupyter lab to run JupyterLab.