Skip to main content

Select and install a Jupyter notebook theme

Project description

# jupyterthemes
## Theme-ify your Jupyter Notebooks!
```sh
jt -t chesterish -cw 850 -f hack -fs 10
```
![image](https://github.com/dunovank/jupyter-themes/blob/master/screens/jt-tchesterish-cw850-fs10.png?raw=true)

```sh
jt -t oceans16 -alt -f hack -fs 10 -cw 900
```
![image](https://github.com/dunovank/jupyter-themes/blob/master/screens/jt-toceans16-altmd-fs10-cw900.png?raw=true)

```sh
jt -t onedork -f hack -fs 10 -cw 850
```
![image](https://github.com/dunovank/jupyter-themes/blob/master/screens/jt-tonedork-cw850-fs10.png?raw=true)

```sh
jt -t grade3 -alt -fs 10 -cw 900 -tf ptserif
```
![image](https://github.com/dunovank/jupyter-themes/blob/master/screens/jt-tgrade3-altmd-fs10-cw900.png?raw=true)

```sh
jt -t onedork -nf ptserif -tf ptserif
```
![image](https://github.com/dunovank/jupyter-themes/blob/master/screens/jt-tonedork-ffserif-tcffserif.png?raw=true)

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


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


## Known Issues

* **UPDATE**: lesscpy has added support for 3.5 to their development branch but still waiting for this to make it's way into the official release on pypi. Soon...

* jupyterthemes relies on [lesscpy](https://github.com/lesscpy/lesscpy) to compile the custom arguments supplied by the user into into the css body that eventually gets saved as custom.css in your jupyter config directory.

* Unfortunately, lesscpy currently only supports up to Python 3.4. If you're running Python 3.5 you can still install and use jupyterthemes but you won't be able to modify the default settings (e.g., font, font-size, cell width, etc.). See [*Examples for 3.5 Users*](https://github.com/dunovank/jupyter-themes/tree/develop#examples-for-python-35-users).


## Command Line Usage

```
usage: jt [-h] [-l] [-t THEME] [-f MONOFONT] [-fs MONOSIZE] [-nf NBFONT]
[-nfs NBFONTSIZE] [-tf TCFONT] [-tfs TCFONTSIZE] [-cw CELLWIDTH]
[-lh LINEHEIGHT] [-alt] [-vim] [-T] [-N] [-r]
```

| options | arg | default |
|:----------------------|:---------:|:--------------:|
| Usage help | -h | -- |
| List Themes | -l | -- |
| Theme Name to Install | -t | -- |
| Code Font | -f | source |
| Code Font-Size | -fs | 11 |
| NB Font | -nf | opensans |
| NB Font Size | -nfs | 13 |
| Txt and MD Font | -tf | ptserif |
| Txt and MD Fontsize | -tfs | 13 |
| Cell Width | -cw | 980 |
| Line Height | -lh | 170 |
| Alt Txt/MD Layout | -alt | -- |
| Style Vim NBExt | -vim | -- |
| Toolbar Visible | -T | -- |
| Name & Logo Visible | -N | -- |
| Restore Default | -r | -- |

## 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 sizes converted into floats (115-->11.5pt)
jt -t grade3 -f fira -fs 115

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

# adjust cell width and line-height
jt -t chesterish -cw 900 -lh 170

# choose alternate txt/markdown layout
jt -t grade3 -alt

# restore default theme
jt -r
```

## Examples for Python 3.5 users:
```sh
# install a theme
jt -t grade3
# list theme
jt -l
# reset theme
jt -r

```

## Monospace Fonts (codecells)
| -f arg | Monospace Font |
|:--|:--|
|anka|Anka/Coder|
|anonymous|Anonymous Pro|
|aurulent|Aurulent Sans Mono|
|bitstream|Bitstream Vera Sans Mono|
|bpmono|BPmono|
|code|Code New Roman|
|consolamono|Consolamono|
|cousine|Cousine|
|dejavu|DejaVu Sans Mono|
|droidmono|Droid Sans Mono|
|fira|Fira Mono|
|firacode|Fira Code|
|generic|Generic Mono|
|hack|Hack|
|inconsolata|Inconsolata-g|
|liberation|Liberation Mono|
|meslo|Meslo|
|office|Office Code Pro|
|oxygen|Oxygen Mono|
|roboto|Roboto Mono|
|saxmono|saxMono|
|source|Source Code Pro|
|sourcemed|Source Code Pro Medium|
|ubuntu|Ubuntu Mono|

## Sans-Serif Fonts
| -nf/-tf arg | Sans-Serif Font |
|:--|:--|
|opensans|Open Sans|
|droidsans|Droid Sans|
|latosans|Lato|
|ptsans|PT Sans|
|robotosans|Roboto|
|sourcesans|Source Sans Pro|

## Serif Fonts
| -nf/-tf arg | Serif Font |
|:--|:--|
|ptserif|PT Serif|
|georgiaserif|Georgia|
|crimsonserif|Crimson Text|
|droidserif|Droid Serif|
|ebserif|EB Garamond|
|loraserif|Lora|
|merriserif|Merriweather|

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.11.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

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

jupyterthemes-0.11.0-py2.py3-none-any.whl (46.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for jupyterthemes-0.11.0.tar.gz
Algorithm Hash digest
SHA256 642cd3fedfa3006c49f7adb2be82ab347008f9bde6fc2a3b0e6773ab0fdb3d85
MD5 a007f39a28e2c2dd0b77f64dba66dc48
BLAKE2b-256 f0868b39cee5314abf37cc17b9ecd2c2ae36dad55a942d39c8f13fc01eafa773

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterthemes-0.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4384641d79f9ca790d050aa7bf5e38a4ec76aab8d3a9c999b5adf6616fd1535f
MD5 29accc2342470aab70e1065fc3f0eac9
BLAKE2b-256 88e89877af72ab9080c76c8780ff830c99b1a5e659dac6f563e36c6cd0e30c7c

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