Skip to main content

Select and install a Jupyter notebook theme

Project description

### TravisCI Build status:
![image](https://travis-ci.org/dunovank/jupyter-themes.svg?branch=develop)

### Interactive Binder Demo
[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org:/repo/dunovank/jupyter-themes)

### Links
[jupyterthemes on PyPI](https://pypi.python.org/pypi/jupyterthemes/)

[jupyterthemes on GitHub](https://github.com/dunovank/jupyter-themes)

### Install with pip
```sh
pip install jupyterthemes
```

### Command Line Usage
```
usage: jt [-h] [-l] [-t THEME] [-f MONOFONT] [-fs MONOSIZE] [-nf NBFONT]
[-nfs NBFONTSIZE] [-tf TCFONT] [-tfs TCFONTSIZE] [-m MARGINS]
[-cursw CURSORWIDTH] [-cursc CURSORCOLOR] [-cellw CELLWIDTH]
[-lineh LINEHEIGHT] [-alt] [-vim] [-T] [-N] [-r]
```


| options | arg | default |
|:----------------------|:---------:|:-------------:|
| Usage help | -h | -- |
| List Themes | -l | -- |
| Theme Name to Install | -t | -- |
| Code Font | -f | droidmono |
| Code Font-Size | -fs | 11 |
| Notebook Font | -nf | exosans |
| Notebook Font Size | -nfs | 13 |
| Text/MD Cell Font | -tf | loraserif |
| Text/MD Cell Fontsize | -tfs | 13 |
| Intro Page Margins | -m | auto |
| Cell Width | -cellw | 980 |
| Line Height | -lineh | 170 |
| Cursor Width | -cursw | 2 |
| Cursor Color | -cursc | -- |
| Alt Text/MD Layout | -alt | -- |
| Alt Prompt Layout | -altp | -- |
| Style Vim NBExt* | -vim | -- |
| Toolbar Visible | -T | -- |
| Name & Logo Visible | -N | -- |
| Restore Default | -r | -- |

\* Vim extension compatibility provided by [alextfkd](https://github.com/alextfkd)

### Examples
```sh
# list available themes
# oceans16 | grade3 | chesterish | onedork
jt -l

# select theme...
jt -t chesterish

# toggle toolbar ON and notebook name ON
jt -t grade3 -T -N

# set code font to 'Roboto Mono' 12pt
# (see monospace font table below)
jt -t oceans16 -f roboto -fs 12

# set code font to Fira Mono, 11.5pt
# 3digit font-size gets converted into float (115-->11.5)
jt -t grade3 -f fira -fs 115

# set text-cell/markdown and notebook fonts
# (see sans-serif & serif font tables below)
jt -t onedork -tf georgiaserif -nf droidsans

# adjust cell width, line-height of codecells
jt -t chesterish -cellw 900 -lineh 170

# fix the container-margins on the intro page (defaults to 'auto')
jt -t onedork -m 200

# adjust cursor width (in px) and make cursor red (r)
# options: b (blue), o (orange), r (red), p (purple), g (green)
jt -t grade3 -cursc r -cursw 5

# toggle toolbar ON and notebook name ON
jt -t grade3 -T -N

# choose alternate txt/markdown layout (-alt)
# and alternate cell prompt (narrow, no numbers)
jt -t grade3 -alt -altp

# restore default theme
jt -r
```

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterthemes-0.13.0.tar.gz (7.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyterthemes-0.13.0-py2.py3-none-any.whl (11.6 MB view details)

Uploaded Python 2Python 3

File details

Details for the file jupyterthemes-0.13.0.tar.gz.

File metadata

File hashes

Hashes for jupyterthemes-0.13.0.tar.gz
Algorithm Hash digest
SHA256 2af254d6c8adc5ffa1be1aaf81cb5d57ca8235dc6888b363a0ab09654454bdb1
MD5 8dc355695ddb24090fd33cfceb02c64d
BLAKE2b-256 a4bab231531f04c25fc4c2b23d5de9692220f9e0f720c6f2517cb3312716a656

See more details on using hashes here.

File details

Details for the file jupyterthemes-0.13.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterthemes-0.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a0246806dbe1c6ef62fbcb5576865eebab07d5aa9c9c48d33bff8dc2be1e80b1
MD5 f694b3668e6889997c24650f562b8650
BLAKE2b-256 4aef71ada671c24b787ca1df09174b78576d9791d12e0457c0717d30b07d153a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page