A package to strip metadata from code cells and markdowns without editing the output in Jupyter notebooks.
Project description
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
- Kyriaki Mavropoulou (kyriaki@quanterra.gr) - Initial work
History
0.1.0 (02-March-2024)
First release on PyPI: https://pypi.org/project/strip-notebook-metadata/
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
Built Distribution
Hashes for strip-notebook-metadata-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 044255ee40735c8aaa8e75fc268b27caf443c59fb71232f69ab62606c70090e7 |
|
MD5 | 4217945ff5d1fa52e1e544e16e28954d |
|
BLAKE2b-256 | 8640ad5fc26e8ea993c6e0963e1410147766375abed5ddbedfb7c9344688595d |
Hashes for strip_notebook_metadata-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2c557b76e61437e2c29b55811d1a8174ae3e089989bd6d76cc0dbe0b55f96d7 |
|
MD5 | b9c3378db757f03dac0c3ff6d2498e8b |
|
BLAKE2b-256 | f5e9219b9ac00135f79dc36f7e5f6bc2f92b1885804ba4aa5a8c227277674a91 |