Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uetchy/juno

☄️ A minimal app serving Jupyter Notebook on macOS menubar.
https://github.com/uetchy/juno

electron jupyter jupyter-notebook macos

Last synced: 2 months ago
JSON representation

☄️ A minimal app serving Jupyter Notebook on macOS menubar.

Awesome Lists containing this project

README

        


logo

Jupyter Notebook stays on macOS menubar.



demo gif

[![GitHub release](https://img.shields.io/github/release/uetchy/juno.svg?maxAge=2592000)](https://github.com/uetchy/juno/releases/latest)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/uetchy/juno/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/uetchy/juno.svg)](https://github.com/uetchy/juno/issues)
[![Join the chat at https://gitter.im/uetchy/juno](https://badges.gitter.im/uetchy/juno.svg)](https://gitter.im/uetchy/juno?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.com/uetchy/juno.svg?branch=master)](https://travis-ci.com/uetchy/juno)

## Download

See [releases](https://github.com/uetchy/juno/releases).

### Supported platforms

- macOS

## Requirements

- Jupyter Notebook

### How to install Jupyter Notebook

```
brew install python3
pip3 install jupyter
jupyter notebook
```

## Config

Juno config is located on `~/.junorc.json`.

default parameters are:

```jsonc
{
"jupyterCommand": "/usr/local/bin/jupyter-notebook", // executable path for Jupyter Notebook
"jupyterPort": 8888, // server port
"jupyterHome": "~", // root folder
"openBrowserOnStartup": true, // set true if let Juno open browser after launch
"preferLab": false // open Jupyter Lab instead of Jupyter Notebook
}
```

### JupyterLab

You can also specify `/usr/local/bin/jupyter-lab` to `jupyterCommand` to utilize
Jupyter Lab (you may also want to install `jupyterlab` via `pip3 install jupyterlab`.)

### pyenv

Put `~/.pyenv/shims/jupyter` into `jupyterCommand` if you are on pyenv-enabled
environment.

## Launch Juno from Terminal

Add `juno` command to open Jupyter notebooks from Terminal. Put following code
to your shell config file.

```bash
juno() {
open -a Juno $1
}
```

to open a notebook:

```
juno "Untitled.ipynb"
```

## Bugs

Feel free to [report issues](https://github.com/uetchy/juno/issues/new).

## Roadmap

- [x] Launch Juno in specified directory
- [x] Terminal integration
- [x] Test suite
- [x] Auto update

## Screenshots

![](http://uechi-public.s3.amazonaws.com/github/juno/screenshot.png)
![](http://uechi-public.s3.amazonaws.com/github/juno/open-with-juno.png)

## Development Installation

```
npm install
npm start
```

### Test & Build

```
npm test
npm run build
```

## License

MIT © [Yasuaki Uechi]([email protected])