Skip to content

JuanLara18/notebook-converter

Repository files navigation

Notebook Converter

Python 3.10+ Streamlit License: MIT CI

Convert Jupyter Notebooks into organized, shareable Python packages — code, outputs, images, and full markdown documentation bundled in a single ZIP.

Try the live app: notebook-converter.streamlit.app

Demo: upload .ipynb files, configure options, preview output, and download the ZIP package

Features

  • Batch processing — convert multiple .ipynb files at once.
  • Code extraction — clean Python scripts from code cells.
  • Output & image preservation — cell outputs as text, images as PNG/JPEG/GIF.
  • Full documentation — markdown that mirrors the notebook structure with code, outputs, and original markdown cells.
  • Configurable — remove magic commands, add cell numbers, custom ZIP names, encoding selection.

Quick Start

git clone https://github.com/JuanLara18/notebook-converter.git
cd notebook-converter
pip install -r requirements.txt
streamlit run app.py

Documentation

Full guides are in the docs/ folder:

Guide Description
Installation Prerequisites, pip/Poetry setup
User Guide Usage workflow and configuration options
Output Format ZIP structure and documentation format
Development Architecture, tests, linting

Contributing

Contributions are welcome — see CONTRIBUTING.md for guidelines.

License

MIT — see LICENSE for details.

Author

Juan Lara — GitHub

About

Convert Jupyter Notebooks into organized Python packages with code, outputs, and markdown documentation

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors

Languages