doit¶

The use of doit is an implementation detail, and is subject to change!

Under the hood, the CLI is powered by doit, a lightweight task engine in python comparable to make.

Using Tasks with the API¶

In [ ]:

import os, pathlib, tempfile, shutil, atexit, hashlib
from IPython.display import *
from IPython import get_ipython # needed for `jupyter_execute` because magics?
import IPython
if "TMP_DIR" not in globals():
    TMP_DIR = pathlib.Path(tempfile.mkdtemp(prefix="_my_lite_dir_"))
    def clean():
        shutil.rmtree(TMP_DIR)
    atexit.register(clean)
os.chdir(TMP_DIR)
print(pathlib.Path.cwd())

The LiteManager collects all the tasks from Addons, and can optionally accept a task_prefix in case you need to integrate with existing tasks.

In [ ]:

from jupyterlite.manager import LiteManager
manager = LiteManager(
    task_prefix="lite_"
)
manager.initialize()
manager.doit_run("lite_status")

Custom Tasks and `%doit`¶

doit offers an IPython magic, enabled with an extension. This can be combined to create highly reactive build tools for creating very custom sites.

In [ ]:

%reload_ext doit

It works against the __main__ namespace, which won't have anything by default.

In [ ]:

%doit list

All the JupyterLite tasks can be added by updating __main__ via globals

In [ ]:

globals().update(manager._doit_tasks)

Now when a new task is created, it can reference other tasks and targets.

In [ ]:

def task_hello():
    return dict(
        actions=[lambda: print("HELLO!")],
        task_dep=["lite_post_status"]
    )

In [ ]:

%doit -v2 hello

doit¶

Using Tasks with the API¶

Custom Tasks and %doit¶

Custom Tasks and `%doit`¶