Skip to main content

A package to strip metadata from code cells and markdowns without editing the output in Jupyter notebooks.

Project description

PyPI - Version

Strip Notebook Metadata

A simple, effective tool for cleaning metadata from Jupyter notebooks. This package helps in reducing the size of notebooks and removing potentially sensitive information stored in metadata, making notebooks cleaner for version control and sharing.

Features

  • Simple Command-Line interface: Easy to use, run it directly from your terminal.
  • Cleans metadata: Strips out metadata from both code and markdown cells.
  • Supports Jupyter Notebooks: Works with .ipynb files, the standard Jupyter notebook format.

Installation

Install strip-notebook-metadata using pip:

pip install strip-notebook-metadata

Dependencies

  • sys
  • nbformat

Usage

To strip metadata from a Jupyter notebook, run:

strip-notebook-metadata path/to/your_notebook.ipynb

Replace path/to/your_notebook.ipynb with the actual path to the notebook you wish to clean.

Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcomed.

Feedback

If you have any feedback, please file an issue on the GitHub repository page. I am always looking to improve and appreciate all feedback, bug reports, and suggestions.

License

This project is licensed under the GPL License - see the LICENSE file for details.

Authors

History

0.1.0 (02-March-2024)

First release on PyPI: https://pypi.org/project/strip-notebook-metadata/

Project details


Download files

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

Source Distribution

strip-notebook-metadata-0.1.1.tar.gz (14.3 kB view hashes)

Uploaded Source

Built Distribution

strip_notebook_metadata-0.1.1-py3-none-any.whl (15.3 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