CLI tool for managing JupyterLab extensions #1
Conversation
|
Thanks for submitting your first pull request! You are awesome! 🤗 |
base_extension_app.py
Outdated
| from jupyterlab.labapp import LabApp | ||
| from jupyterlab.commands import build |
There was a problem hiding this comment.
Those imports should not be needed - it requires to bring them within this package.
For LabApp, it is gonna be tricky. You will need to figure out exactly what part of that class is used to extract it here.
There was a problem hiding this comment.
So as I understand there should only be an init.py file along with a separate file for each functionality extracted like build.py, watch.py etc. All other extracted logic , like contents of these above mentioned imports should be a part of the init.py file. Am I correct? Or can I keep the base_extension_app.py and federated_extensions.py file?
There was a problem hiding this comment.
You can keep the base_extension_app.py and federated_extensions.py files. You can also create (or not) a dedicated file to bring the code from those imports:
from jupyterlab.labapp import LabApp
from jupyterlab.commands import buildFor the LabApp instead of copying all the code (that should be mostly useless), it will be nice to start from an empty class and run the extracted code to see what is actually needed.
My guess is LabApp inherits from LabServerApp that itself inherits of LabConfig. And only attributes of that LabConfig class should be needed here.
federated_extensions.py
Outdated
| from jupyter_core.paths import ENV_JUPYTER_PATH, SYSTEM_JUPYTER_PATH, jupyter_data_dir | ||
| from jupyter_core.utils import ensure_dir_exists | ||
| from jupyter_server.extension.serverextension import ArgumentConflict | ||
| from jupyterlab_server.config import get_federated_extensions |
There was a problem hiding this comment.
That import should not be needed --> meaning that code should be including within this package
|
Hi @fcollonval I have rebased my code on your #2 commit. I have also extracted the methods and classes being used in the federated_extensions.py file. ie I will now move on to extracting code used in these imports Please let me know if I did this correctly. |
|
Thanks a lot @cronan03 I realize my review comment was not specific enough. It is ok to depend on |
|
If you want to check the imported code, you can also import here the tests for that part of the code. They are located in the file: https://github.com/jupyterlab/jupyterlab/blob/6152e3a5f94d728ccd2727d6d8413f12ddafb669/jupyterlab/tests/test_jupyterlab.py#L156 |
Thank you for clarifying @fcollonval . I will keep this in mind moving forward. And no worries, I am happy to learn. |
This pull request introduces a CLI (Command Line Interface) tool for managing JupyterLab extensions, designed to enhance developer workflow. The CLI tool, named jupyterlab-builder, provides commands for developing, building, and watching JupyterLab extensions. It leverages the traitlets library for configuration and flexibility.
Key Features:
Develop Command: Allows developers to set up a development environment for lab extensions, facilitating iterative development and testing.
Build Command: Provides a command for building lab extensions, enabling packaging and distribution.
Watch Command: Enables developers to watch lab extensions for changes and automatically rebuild them, improving productivity during development.
BaseExtensionApp: Implements the core logic for parsing commands and delegating them to appropriate subcommands (DevelopLabExtensionApp, BuildLabExtensionApp, WatchLabExtensionApp).
Usage of Traitlets: Utilizes the traitlets library for defining configuration options and managing application state, ensuring flexibility and ease of customization.