IPython Documentation

Table Of Contents

Previous topic

Module: utils.strdispatch

Next topic

Module: utils.sysinfo

This Page

Note

This documentation is for a development version of IPython. There may be significant differences from the latest stable release.

Module: utils.submodule

utilities for checking submodule status

5 Functions

IPython.utils.submodule.ipython_parent()

return IPython’s parent (i.e. root if run from git)

IPython.utils.submodule.ipython_submodules(root)

return IPython submodules relative to root

IPython.utils.submodule.is_repo(d)

is d a git repo?

IPython.utils.submodule.check_submodule_status(root=None)

check submodule status

Has three return values:

‘missing’ - submodules are absent ‘unclean’ - submodules have unstaged changes ‘clean’ - all submodules are up to date

IPython.utils.submodule.update_submodules(repo_dir)

update submodules in a repo