Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include ipylab dependency for %load_node in Docs and Requirements #3643

Closed
DimedS opened this issue Feb 21, 2024 · 1 comment
Closed

Include ipylab dependency for %load_node in Docs and Requirements #3643

DimedS opened this issue Feb 21, 2024 · 1 comment
Assignees

Comments

@DimedS
Copy link
Contributor

DimedS commented Feb 21, 2024

Description

To enhance user experience with the new %load_node magic command in Jupyter notebooks, will be nice to note the requirement of installing ipylab. We should consider explicitly mentioning this dependency in the documentation. Additionally, integrating ipylab into the requirements.txt of Kedro templates and starters could streamline the user flow, ensuring a smoother setup process.

Upon creating a project using kedro new and installing the dependencies from requirements.txt, which included

ipython>=8.10 and 
jupyterlab>=3.0, 

an error was encountered when attempting to execute the %load_node command in a Jupyter notebook. The error indicated that ipylab was missing, highlighting the necessity for its inclusion in the setup process.

Your Environment

  • Kedro version used: last version, main branch
  • Python version used (python -V): 3.10
  • Operating system and version: MacOS
@noklam
Copy link
Contributor

noklam commented Feb 22, 2024

I think we should leave notebook/lab dependencies in starters, because we don't know if users are going to user notebook or lab and we shouldn't force them. We can include this in starter to make it easier for them, but this leave the flexibility if they need to remove it later.

kedro[jupyter] however only includes ipylab, in theory it also requires Jupyterlab or notebook>7.0. So my proposal is to make this into the starters:

ipython>=8.10 and 
jupyterlab>=3.0
kedro[jupyter]

@merelcht merelcht moved this to To Do in Kedro Framework Aug 5, 2024
@noklam noklam self-assigned this Aug 5, 2024
@noklam noklam moved this from To Do to In Progress in Kedro Framework Aug 5, 2024
@noklam noklam moved this from In Progress to In Review in Kedro Framework Aug 6, 2024
@noklam noklam closed this as completed Aug 16, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

2 participants