Bulk Convert Python files to IPython Notebook Files (py to ipynb conversion)
See Python: Tips and Tricks for similar articles.I had a bunch of Python files that I needed to convert in bulk to Jupyter Notebook files. Jupyter Notebook files are simple JSON files with a cells
array containing one or more unnamed cell nodes.
For example, here’s the code for the simple Jupyter notebook shown in the image above. Note the cells
array and, in particular, the source
key.
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": false
},
"outputs": [],
"source": [
"try:\n",
" 1/0\n",
"except:\n",
" print('You cannot divide by zero!')"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.4.3"
}
},
"nbformat": 4,
"nbformat_minor": 0
}
The only piece we need to change to convert Python files to Jupyter Notebook files is the highlighted source
value, which contains the Python code that goes in the cell. Everything else we can copy verbatim.
My py-to-ipynb.py script looks like this:
import os
from json.encoder import JSONEncoder
nb_start = '''{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": false
},
"outputs": [],
"source": ['''
nb_end =''']
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.4.2"
}
},
"nbformat": 4,
"nbformat_minor": 0
}'''
def main():
for dirpath, dirnames, filenames in os.walk('.'):
for fname in filenames:
path = dirpath+'/'+fname
if fname[-3:] == '.py' and not os.path.samefile(path,'.\\py-to-ipynb.py'):
path = dirpath+'/'+fname
nb_path = path[:-3] + '.ipynb'
with open(path,'r') as f_in:
f_in_content = JSONEncoder().encode(f_in.read())
nb_content = nb_start + f_in_content + nb_end
with open(nb_path,'w') as f_out:
f_out.write(nb_content)
print("Created",nb_path)
main()
Here’s what it does:
- Walks through all the files within the current directory and its subdirectories.
- Reads in the contents of every file (except itself) ending with .py, encodes it as JSON, and stores it as
f_in_content
. - Creates a
nb_content
variable by concatenating…nb_start
– the JSON text that goes before thesource
value in the Jupyter Notebook JSON.f_in_content
nb_end
– the JSON text that goes after thesource
value in the Jupyter Notebook JSON.
- Writes
nb_content
to a new file with the same name, but with a .ipynb extension.
I know it’s a hack, but I couldn’t find a built-in way of doing this. I’ve only done some minimal testing, so use at your own risk. 🙂
Related Articles
- Fixing WebVTT Times with Python
- Using Python to Convert Images to WEBP
- Scientific Notation in Python
- Understanding Python’s __main__ variable
- Converting Leading Tabs to Spaces with Python
- pow(x, y, z) more efficient than x**y % z and other options
- A Python Model for Ping Pong Matches
- Bulk Convert Python files to IPython Notebook Files (py to ipynb conversion) (this article)
- Python’s date.strftime() slower than str(), split, unpack, and concatenate?
- Basic Python Programming Exercise: A Penny Doubled Every Day
- Bi-directional Dictionary in Python
- How to find all your Python installations on Windows (and Mac)
- Associate Python Files with IDLE
- Change Default autosave Interval in JupyterLab
- Python: isdigit() vs. isdecimal()
- Python Clocks Explained
- Python Color Constants Module
- Maximum recursion depth exceeded while calling a Python object
- When to use Static Methods in Python? Never
- Finally, a use case for finally – Python Exception Handling
- Creating an Email Decorator with Python and AWS
- Python Coding Challenge: Two People with the Same Birthday
- How to Create a Simple Simulation in Python – Numeric Data
- Collatz Conjecture in Python
- Simple Python Script for Extracting Text from an SRT File
- Python Virtual Environments with venv
- Mapping python to Python 3 on Your Mac
- How to Make IDLE the Default Editor for Python Files on Windows
- How to Do Ternary Operator Assignment in Python
- How to Convert Seconds to Years with Python
- How to Create a Python Package
- How to Read a File with Python
- How to Check the Operating System with Python
- How to Use enumerate() to Print a Numbered List in Python
- How to Repeatedly Append to a String in Python
- Checking your Sitemap for Broken Links with Python
- How to do Simultaneous Assignment in Python
- Visual Studio Code - Opening Files with Python open()
- How to Slice Strings in Python
- How Python Finds Imported Modules
- How to Merge Dictionaries in Python
- How to Index Strings in Python
- How to Create a Tuple in Python