CLI

Convenience CLI utils for fastrl projects

from execnb.nbio import *
from execnb.shell import *

fastrl_make_requirements

 fastrl_make_requirements (path:pathlib.Path=None,
                           project_file:str='settings.ini',
                           out_path:pathlib.Path=None, verbose:bool=False)

	Type	Default	Details
path	Path	None	The path to a dir with the settings.ini, if none, cwd.
project_file	str	settings.ini	The file to load for reading the requirements
out_path	Path	None	The output path (can be relative to `path`)
verbose	bool	False	Output to stdout

fastrl_nbdev_docs

 fastrl_nbdev_docs (path:str=None, n_workers:int=2, verbose:bool=False,
                    one2one:bool=True, file_glob:str=None,
                    file_re:str='\\.(?:ipynb|qmd|html)$',
                    symlinks:bool=False, folder_re:str=None,
                    skip_file_glob:str=None, skip_file_re:str='^[_.]',
                    skip_folder_re:str='^[_.]')

Create Quarto docs and README.md

	Type	Default	Details
path	str	None	Path to notebooks
n_workers	int	2	Number of workers
verbose	bool	False	verbose outputs
one2one	bool	True	Run 1 notebook per process instance.
file_glob	str	None	Only include files matching glob
file_re	str	.(?:ipynb\|qmd\|html)$	Only include files matching regex
symlinks	bool	False	Follow symlinks?
folder_re	str	None	Only enter folders matching regex
skip_file_glob	str	None	Skip files matching glob
skip_file_re	str	^[_.]	Skip files matching regex
skip_folder_re	str	^[_.]	Skip folders matching regex

proc_nbs

 proc_nbs (path:str='', n_workers:int=2, force:bool=False,
           file_glob:str='', verbose:bool=False, one2one:bool=True,
           symlinks:bool=False, file_re:str=None, folder_re:str=None,
           skip_file_glob:str=None, skip_file_re:str='^[_.]',
           skip_folder_re:str='^[_.]')

Process notebooks in path for docs rendering

	Type	Default	Details
path	str		Path to notebooks
n_workers	int	2	Number of workers
force	bool	False	Ignore cache and build all
file_glob	str		Only include files matching glob
verbose	bool	False	verbose outputs
one2one	bool	True	Run 1 notebook per process instance.
symlinks	bool	False	Follow symlinks?
file_re	str	None	Only include files matching regex
folder_re	str	None	Only enter folders matching regex
skip_file_glob	str	None	Skip files matching glob
skip_file_re	str	^[_.]	Skip files matching regex
skip_folder_re	str	^[_.]	Skip folders matching regex

fastrl_nbdev_test

 fastrl_nbdev_test (path:str=None, flags:str='', n_workers:int=None,
                    timing:bool=False, do_print:bool=False,
                    pause:float=0.01, ignore_fname:str='.notest',
                    one2one:bool=True, symlinks:bool=False,
                    file_glob:str='*.ipynb', file_re:str=None,
                    folder_re:str=None, skip_file_glob:str=None,
                    skip_file_re:str='^[_.]', skip_folder_re:str='^[_.]')

Test in parallel notebooks matching path, passing along flags

	Type	Default	Details
path	str	None	A notebook name or glob to test
flags	str		Space separated list of test flags to run that are normally ignored
n_workers	int	None	Number of workers
timing	bool	False	Time each notebook to see which are slow
do_print	bool	False	Print start and end of each notebook
pause	float	0.01	Pause time (in seconds) between notebooks to avoid race conditions
ignore_fname	str	.notest	Filename that will result in siblings being ignored
one2one	bool	True	Run 1 notebook per process instance.
symlinks	bool	False	Follow symlinks?
file_glob	str	*.ipynb	Only include files matching glob
file_re	str	None	Only include files matching regex
folder_re	str	None	Only enter folders matching regex
skip_file_glob	str	None	Skip files matching glob
skip_file_re	str	^[_.]	Skip files matching regex
skip_folder_re	str	^[_.]	Skip folders matching regex

# fastrl_nbdev_test(n_workers=1)