"""
Change Jupyter configuration
:githublink:`%|py|5`
"""
import sys
import os
import re
from ..installhelper.link_shortcuts import add_shortcut_to_desktop, suffix
def noLOG(*args, **kwargs):
pass
[docs]def install_mathjax():
"""
install a local copy of mathjax
:githublink:`%|py|19`
"""
from IPython.external import mathjax # pylint: disable=E1101
mathjax.install_mathjax()
[docs]def setup_ipython(current_path=None, additional_path=None, apply_modification=True,
shortcut=True, browser=None):
"""
The function applies the modification suggested in this blog post:
`Travailler avec IPython notebook <http://www.xavierdupre.fr/blog/2014-02-24_nojs.html>`_ (written in French).
:param additional_path: additional paths to add to jupyter (a list)
:param current_path: change the current path when running a notebook
:param apply_modification: apply the modification, otherwise, just create the profile
:param shortcut: add short cut the desktop
:param browser: if not None, tries to change if it finds it (IE, Chrome, Firefox, on Windows)
:return: path the config file
If you need to create a shortcut with the appropriate paths,
you can use the following instructions
to open :epkg:`Jupyter` notebook on a specific folder:
::
set path=%path%;c:\\Python370_x64;c:\\Python370_x64\\Scripts
jupyter-notebook --notebook-dir=_doc\\notebooks
:githublink:`%|py|45`
"""
if sys.platform.startswith("win"):
user_profile = os.environ['USERPROFILE']
profile = os.path.join(user_profile, ".jupyter")
ipython_notebook_config = os.path.join(
profile,
"jupyter_notebook_config.py")
checkpath = os.path.join(profile, "checkspoints")
if not os.path.exists(checkpath):
os.mkdir(checkpath)
if not os.path.exists(ipython_notebook_config):
from ..installhelper.install_cmd_helper import run_cmd
exe_exe = os.path.dirname(sys.executable)
if exe_exe.lower().endswith("scripts"):
exe = os.path.join(exe_exe, "jupyter-notebook.exe")
else:
exe = os.path.join(exe_exe, "Scripts", "jupyter-notebook.exe")
cmd = exe + " -y --generate-config"
out, err = run_cmd(cmd, wait=True, fLOG=noLOG)
if not os.path.exists(ipython_notebook_config):
raise Exception(
"unable to create jupyter configuration in \n'{0}'\nbecause of:\n{1}\nERR-4:\n{2}\ncmd={3}".format(
ipython_notebook_config, out, err, cmd))
with open(ipython_notebook_config, "r") as f:
text = f.read()
# change current path and pylab configuration
for var in ["IPKernelApp.file_to_run",
"ProfileDir.location",
"FileNotebookManager.checkpoint_dir",
"NotebookManager.notebook_dir",
"NotebookApp.ipython_dir",
"IPKernelApp.pylab"]:
reg = re.compile("(#? *c.{0} =.*)".format(var))
alls = reg.findall(text)
if len(alls) == 1 and current_path is not None:
if "pylab" in var:
text = text.replace(
alls[0],
"c.{0} = 'inline'".format(var))
elif "checkpoint_dir" in var:
text = text.replace(
alls[0],
"c.{0} = r'{1}'".format(
var,
checkpath))
elif "file_to_run" not in var:
text = text.replace(
alls[0],
"c.{1} = r'{0}'".format(
current_path,
var))
else:
text = text.replace(
alls[0],
"c.{1} = '{0}\\jupyter_startup.py'".format(
current_path,
var))
# browser
if browser is not None:
if sys.platform.startswith("win"):
paths = {"firefox": "C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe",
"ie": "C:\\Program Files\\Internet Explorer\\iexplore.exe",
"chrome": "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe",
}
browser = browser.lower()
if browser not in paths:
raise KeyError(
"unable to find browser {0} in [{1}]".format(
browser, ",".join(
paths.keys())))
subtext = """
import webbrowser
webbrowser.register('{0}', None, webbrowser.GenericBrowser(r'{1}'))
c.NotebookApp.browser = '{0}'
""".format(browser, paths[browser]).replace(" ", "")
text += subtext
else:
raise NotImplementedError("implemented only on Windows")
if apply_modification:
# write modification
with open(ipython_notebook_config, "w") as f:
f.write(text)
# write jupyter_startup.py
rows = ["import sys"]
if additional_path is not None:
for p in additional_path:
if not os.path.exists(p):
raise FileNotFoundError(p)
rows.append("sys.path.append(r'{0}')".format(p))
s = "\n".join(rows)
if apply_modification:
with open(os.path.join(current_path, "jupyter_startup.py"), "w") as f:
f.write(s)
return [ipython_notebook_config]
else:
raise NotImplementedError("implemented only for Windows")
[docs]def add_shortcut_to_desktop_for_ipython(folder):
"""
create a shortcut on your desktop
:param folder: notebook dir
:return: filename
:githublink:`%|py|161`
"""
file = os.path.join(
os.path.split(
sys.executable)[0],
"Scripts",
"jupyter-notebook")
arguments = " --notebook-dir=" + folder
ver = suffix()
return add_shortcut_to_desktop(
file, "notebook." + ver, "Jupyter Notebook {1} ({0})".format(folder, ver), arguments)
if __name__ == "__main__":
setup_ipython("C:\\temp", [], apply_modification=False)
