from nbskill.foundation import demo_path, remove_demo_pathInstalling the skill
Install the notebook workflow instructions, then register reusable local repositories.
The repository ships instructions that teach agents how to use the Python notebook workflow. This installer copies the package-owned skill and references into a requested skills directory.
The package ships a compact routing skill. The operational guidance lives in the Python skill module, so installation copies package-owned instructions rather than generating a second workflow.
Production contract
Skill installation is Python-first. It installs only into the requested Codex or Claude skills directory, optionally installs notebook hooks, and keeps reference indexing separate from normal workflow use.
Installing agent instructions
The installer copies the compact routing skill and its reference material. Native notebook methodology lives in the Python skill module; installation only makes those files available to the chosen agent.
install_nbskill
def install_nbskill(
target:str='codex', # codex, claude, cursor, both, or custom when skills_dir is set
skills_dir:str | None=None, # Parent skills directory; skill is installed below jupyter-notebooks
skill_name:str='jupyter-notebooks', # Skill folder name
overwrite:bool=True, # Update stale managed files
install_hooks:bool=False, # Install nbdev-clean/nbdev-test pre-commit hooks in the current repo
reference_roots:str='~/projects', # Local Git repositories to add to the reference index
index_references:bool=True, # Index references during installation
):Install current Python workflow instructions.
install_nbskill_cli
def install_nbskill_cli():Install notebook workflow instructions from the command line.