How do I convert a IPython Notebook into a Python file via commandline

Question

I m looking at using the   ipynb files as the source of truth and programmatically  compiling  them into  py files for scheduled jobs tasks    The only way I understand to do this is via the GUI  Is there a way to do it via command line

User · Answer

You can do this from the IPython API   from IPython nbformat import current as nbformat from IPython nbconvert import PythonExporter  filepath    path to my notebook ipynb  export path    path to my notebook py   with open filepath  as fh      nb   nbformat reads json fh read     exporter   PythonExporter      source is a tuple of python source code   meta contains metadata source  meta   exporter from notebook node nb   with open export path   w    as fh      fh writelines source

User · Answer

Here is a quick and dirty way to extract the code from V3 or V4 ipynb without using ipython  It does not check cell types  etc   import sys json  f   open sys argv 1    r    input ipynb j   json load f  of   open sys argv 2    w    output py if j  nbformat    gt  4          for i cell in enumerate j  cells                     of write   cell   str i    n                   for line in cell  source                            of write line                  of write   n n   else          for i cell in enumerate j  worksheets   0   cells                     of write   cell   str i    n                   for line in cell  input                            of write line                  of write   n n    of close

User · Answer

I understand this is an old thread  I have faced the same issue and wanted to convert the  pynb file to  py file via command line  My search took me to ipynb-py-convert By following below steps I was able to get  py file  Install  quot pip install ipynb-py-convert quot  Go to the directory where the ipynb file is saved via command prompt Enter the command   gt  ipynb-py-convert YourFileName ipynb YourFilename py Eg   ipynb-py-convert getting-started-with-kaggle-titanic-problem ipynb getting-started-with-kaggle-titanic-problem py Above command will create a python script with the name  quot YourFileName py quot  and as per our example it will create getting-started-with-kaggle-titanic-problem py file

User · Answer

For converting all   ipynb format files in current directory to python scripts recursively   for i in   ipynb      ipynb  do      echo   i      jupyter nbconvert    i    i  done

User · Answer

Following the previous example but with the new nbformat lib version     import nbformat from nbconvert import PythonExporter  def convertNotebook notebookPath  modulePath      with open notebookPath  as fh      nb   nbformat reads fh read    nbformat NO CONVERT     exporter   PythonExporter     source  meta   exporter from notebook node nb     with open modulePath   w    as fh      fh writelines source encode  utf-8

User · Answer

Jupytext is nice to have in your toolchain for such conversions  It allows not only conversion from a notebook to a script  but you can go back again from the script to notebook as well  And even have that notebook produced in executed form  jupytext --to py notebook ipynb                   convert notebook ipynb to a  py file jupytext --to notebook notebook py                convert notebook py to an  ipynb file with no outputs jupytext --to notebook --execute notebook py      convert notebook py to an  ipynb file and run it

User · Answer

I had this problem and tried to find the solution online  Though I found some solutions  they still have some problems  e g   the annoying Untitled txt auto-creation when you start a new notebook from the dashboard  So eventually I wrote my own solution  import io import os import re from nbconvert exporters script import ScriptExporter from notebook utils import to api path   def script post save model  os path  contents manager    kwargs        quot  quot  quot Save a copy of notebook to the corresponding language source script       For example  when you save a  foo ipynb  file  a corresponding  foo py      python script will also be saved in the same directory       However  existing config files I found online  including the one written in     the official documentation   will also create an  Untitile txt  file when     you create a new notebook  even if you have not pressed the  quot save quot  button      This is annoying because we usually will rename the notebook with a more     meaningful name later  and now we have to rename the generated script file      too       Therefore we make a change here to filter out the newly created notebooks     by checking their names  For a notebook which has not been given a name      i e   its name is  Untitled     the corresponding source script will not be     saved  Note that the behavior also applies even if you manually save an      quot Untitled quot  notebook  The rationale is that we usually do not want to save     scripts with the useless  quot Untitled quot  names       quot  quot  quot        only process for notebooks     if model  quot type quot       quot notebook quot           return      script exporter   ScriptExporter parent contents manager      base       os path splitext os path         do nothing if the notebook name ends with  Untitled 0-9        regex   re compile r quot Untitled 0-9    quot       if regex search base           return      script  resources   script exporter from filename os path      script fname   base   resources get  output extension     txt        log   contents manager log     log info  quot Saving script at   s quot                to api path script fname  contents manager root dir        with io open script fname   quot w quot   encoding  quot utf-8 quot   as f          f write script   c FileContentsManager post save hook   script post save  To use this script  you can add it to    jupyter jupyter notebook config py    Note that you may need to restart the jupyter notebook   lab for it to work

User · Answer

If you don t want to output a Python script every time you save  or you don t want to restart the IPython kernel   On the command line  you can use nbconvert     jupyter nbconvert --to script  YOUR NOTEBOOK  ipynb   As a bit of a hack  you can even call the above command in an IPython notebook by pre-pending    used for any command line argument   Inside a notebook    jupyter nbconvert --to script config template ipynb   Before --to script was added  the option was --to python or --to python  but it was renamed in the move toward a language-agnostic notebook system

User · Answer

There s a very nice package called nb dev which is designed for authoring Python packages in Jupyter Notebooks   Like nbconvert  it can turn a notebook into a  py file  but it is more flexible and powerful because it has a lot of nice additional authoring features to help you develop tests  documentation  and register packages on PyPI   It was developed by the fast ai folks     It has a bit of a learning curve  but the documentation is good and it is not difficult overall

User · Answer

If you want to convert all   ipynb files from current directory to python script  you can run the command like this   jupyter nbconvert --to script   ipynb

User · Answer

The following example turns an Iron Python Notebook called a notebook ipynb into a python script called a python script py leaving out the cells tagged with the keyword remove  which I add manually to the cells that I don t want to end up in the script  leaving out visualizations and other steps that once I am done with the notebook I don t need to be executed by the script  import nbformat as nbf from nbconvert exporters import PythonExporter from nbconvert preprocessors import TagRemovePreprocessor  with open  quot a notebook ipynb quot    r   encoding  utf-8   as f      the notebook nodes   nbf read f  as version   4   trp   TagRemovePreprocessor    trp remove cell tags     quot remove quot     pexp   PythonExporter    pexp register preprocessor trp  enabled  True   the python script  meta   pexp from notebook node the notebook nodes   with open  quot a python script py quot    w   as f      f writelines the python script

[ipython] How do I convert a IPython Notebook into a Python file via commandline?

Examples related to ipython

Examples related to ipython-notebook