Compress images in IPython/Jupyter notebooks
Project description
Overview
So you have included an image with IPython.display.Image() and the file size of your IPython Notebook got huge? No problem! This package will resize images in your notebook and compress them as PNG or JPEG. Images are only resized if they are above the specified width. 2048px and PNG compression is the default, which should give relative high quality images and normal sized notebooks. JPEG compression is nice if you serve the notebooks over the web (eg nbviewer) and prefer fast loading times.
Installation
Install using pip…
pip install ipynbcompress
Example
From command line:
$ ipynb-compress notebook4.ipynb notebook4.ipynb: 10 megabytes decrease $ find . -name "*ipynb" -size +2M -exec ipynb-compress {} \; ./lab 03.21/automated scan.ipynb: warning: no compression - 0 bytes gained ./lab 03.21/automated scan.ipynb: compression less than 100k bytes - keeping original ./lab 03.21/trouble.ipynb: 9 megabytes decrease ...
In python:
>>> import os >>> from ipynbcompress import compress >>> filename = '/path/to/notebook.ipynb' >>> out = '/path/to/compressed.ipynb' >>> # original size ... os.stat(filename).st_size 11563736 >>> # return bytes saved ... compress(filename, output_filename=out, img_width=800, img_format='jpeg') 11451545 >>> compress(filename, output_filename=out, img_width=800, img_format='png') 11205762 >>> # defaults to img_width = 2048px and png compression ... compress(filename, output_filename=out) 11411377 >>> # overwrite existing notebook ... compress(filename) 11411377
API reference
API reference is at http://ipynbcompress.rtfd.org.
Development
Install dependencies and link development version of ipynbcompress to pip:
git clone https://github.com/arve0/ipynbcompress cd ipynbcompress pip install -r requirements.txt # install dependencies and ipynbcompress-package
Testing
tox
Build documentation locally
To build the documentation:
pip install -r docs/requirements.txt make docs
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size ipynbcompress-0.3.0-py2.py3-none-any.whl (6.6 kB) | File type Wheel | Python version 3.4 | Upload date | Hashes View |
Filename, size ipynbcompress-0.3.0.tar.gz (8.4 MB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for ipynbcompress-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfa52698fd179452e09a7d4c958f21385a15ce7df9fdd63e4df2d6a0174a280d |
|
MD5 | 8fa61059fd050a0d2d1998f1be400366 |
|
BLAKE2-256 | 01513cd8b535fc48bb3ee79ba670f00bed5703c383a99f49e208613696cc25f7 |