xeus-python-kernel icon indicating copy to clipboard operation
xeus-python-kernel copied to clipboard

Development build instructions are broken

Open omert opened this issue 2 years ago • 1 comments

There are some issues with the development build instructions. Some are mistakes, and others are places where the instructions might be more helpful.

Here are the current development build instructions, with issues interspersed.

# Clone the repo to your local environment
# Change directory to the jupyterlite_xeus_python directory

Changing into this directory makes the next command not work.

# Install package in development mode
python -m pip install -e .

# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite

This requires jupyter to be installed. What is the best way to do that? Should conda be used, and if so how?

# Rebuild extension Typescript source after making changes
jlpm run build

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

What if we we want to run jupyterlite rather than Jupyter?

omert avatar Aug 17 '22 16:08 omert

Thanks for opening an issue.

Indeed, the README is really not up-to-date. It might have been a copy-paste from another Jupyter project but it does not apply here.

I will push a PR soonish to update it.

martinRenou avatar Aug 18 '22 07:08 martinRenou