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)

### Requirements
* Python 2.7, 3.3, 3.4, or 3.5
* Jupyter ([Anaconda](https://www.continuum.io/downloads) recommended)

### Recent updates

###### v0.14.0
* add solarized light theme (added by [svendx4f](https://github.com/svendx4f)
* fixed bug that prevented theme reset
* fixed bug that prevented cursor settings from being applied
* made upload button visible on main page
* other minor thematic adjustments

###### v0.13.9
* minor bug fixes and thematic adjustments

###### v0.13.8
* add monokai theme ([bdell](https://github.com/bdell) : [PR #59](https://github.com/dunovank/jupyter-themes/pull/59))
* apply theme to auto-complete menu ([svendx4f](https://github.com/svendx4f) : [PR #69](https://github.com/dunovank/jupyter-themes/pull/69))
* added support for user less/precompiled themes ([osamaar](https://github.com/osamaar) : [PR #82](https://github.com/dunovank/jupyter-themes/pull/82))


### 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 | -- |

### Examples
```sh
# list available themes
# oceans16 | grade3 | chesterish | onedork | monokai
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.14.0.tar.gz (8.1 MB view details)

Uploaded Source

Built Distributions

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

jupyterthemes-0.14.0-py2.py3-none-any.whl (8.1 MB view details)

Uploaded Python 2Python 3

jupyterthemes-0.14.0-py2.7.egg (8.1 MB view details)

Uploaded Egg

File details

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

File metadata

File hashes

Hashes for jupyterthemes-0.14.0.tar.gz
Algorithm Hash digest
SHA256 fea17885c22d5df58f85187afcb408efdf6d99d5606a104da15fa134e76c8ea4
MD5 717776ad2816c0ae91c4dccb488943fb
BLAKE2b-256 3362c78aa3b048fd692bbbe708cb981917612039c14e17dfc2db28afa4e9f60f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterthemes-0.14.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f25a981516c402f5ea097de0890b21feddcdca64ca08ddc1968ba7f268abb3c9
MD5 14f8a23c7770156b9ca4b8e280762e66
BLAKE2b-256 1820e60db9312a1df5fbc93d60eb239c302df9864919f953c9471b24481885ce

See more details on using hashes here.

File details

Details for the file jupyterthemes-0.14.0-py2.7.egg.

File metadata

File hashes

Hashes for jupyterthemes-0.14.0-py2.7.egg
Algorithm Hash digest
SHA256 c0d828ed1e16d5443a73c2b73864d22ac97c3f460029842ff8f5e8a9180eee6d
MD5 9d1a0b5eb569071b26b1fe359cba96df
BLAKE2b-256 d4ee3e4ff9f8d2dd1e942907bf7d0841ac8b1242b0975f9f1c58906732a971d7

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