CLI tools

Some support scripts for maintaining the book

A little script to correct chapter indices to base 1:

rename

def rename(
    dir:str, # dir in which to rename files
    suffix:str='.ipynb', # suffix of files to change
):

Rename notebooks to base 1 for chapters.

A function to read a notebook and fix its colab links:

source

fix_colab_links

def fix_colab_links(
    nb:dict, name:str
):

Fix colab links in nb

# Let's read a notebook in the test folder
# No longer works in nbdev2 as it "fixes" the files in test, even when recursive = false
# name = 'nb_with_colab_link'
# nb = json.loads(open(f'test/{name}.ipynb', 'r', encoding='utf-8').read())

# fix_colab_links(nb, 'nb_with_colab_link')

# assert _colab_link_name(nb) == name
# assert nb['metadata']['colab']['name'] == name + '.ipynb'

---------------------------------------------------------------------------
AssertionError                            Traceback (most recent call last)
/var/folders/j1/srk75rwh8xldbn006s6xkd8r0000gp/T/ipykernel_70403/1858130178.py in <module>
      5 fix_colab_links(nb, 'nb_with_colab_link')
      6 
----> 7 assert _colab_link_name(nb) == name
      8 assert nb['metadata']['colab']['name'] == name + '.ipynb'

AssertionError:

A script to do this for all the notebooks

source

fix_nbs_colab_links

def fix_nbs_colab_links(
    dir:str, # dir in which to rename files
):

Fix colab links in all notebooks in directory.