Skip to main content

Compress images in IPython/Jupyter notebooks

Project description

build-status-image pypi-version wheel

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 JPG or PNG.

Installation

Install using pip

pip install ipynbcompress

Example

From command line:

$ ipynb-compress notebook4.ipynb
notebook4.ipynb: 10 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 = 1024px and jpeg 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.

Files for ipynbcompress, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size ipynbcompress-0.2.1-py2.py3-none-any.whl (6.3 kB) File type Wheel Python version 3.4 Upload date Hashes View hashes
Filename, size ipynbcompress-0.2.1.tar.gz (8.4 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page