Skip to main content

Cleanup Jupyter Notebook files

Project description

Jupyter notebook cleanup

Working with PyCharm and your Jupyter notebooks becoming quite heavy and slow down your system? This project contains some tools to cleanup you Jupyter notebooks.


You may want to remove the output of all cells since loading the notebook takes ages. You can either use jp-cleanup on the command line or programmatically.


At first, install jp-cleanup with pip using the version on GitHub

pip install git+

or on PyPi

pip install jp-cleanup

After installation, you can clear the output fields of a notebook test-notebook with

jp-cleanup --file test-notebook.ipynb --clear

with --clear being an extra flag to not remove the output of a notebook accidentally.

To list all available parameters or view the current version, run jp-cleanup with the --help flag.

jp-cleanup --help


Instead of running jp-cleanup on the command-line, you can also use the package in Python. To remove the outputs of a certain jupyter notebook test-notebook, load the file

import jpcleanup as jpc

path, content = jpc.load('test-notebook') # or with .ipynb

reset the output of all cells

content = jpc.clear_field(content)

and write the result back to either the same file, path) 

or a new file, 'test-result') # or with .ipynb


Either clone this project with

git clone

to extend the functionality of the project or, since the the project is hosted on PyPi, install it with

pip install jp-cleanup


pip install git+


Copyright (C) 2019 Lars Klitzke,

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

jp_cleanup-0.1.1-py3-none-any.whl (4.8 kB view hashes)

Uploaded Python 3

Supported by

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