Skip to content

README.md

Latest commit

 

History

History
99 lines (74 loc) · 3.47 KB

README.md

File metadata and controls

99 lines (74 loc) · 3.47 KB
Raw

{{ cookiecutter.python_name }}

[![Github Actions Status]({{ cookiecutter.repository }}/workflows/Build/badge.svg)]({{ cookiecutter.repository }}/actions/workflows/build.yml) {%- if cookiecutter.has_binder.lower().startswith('y') -%} [Binder](https://mybinder.org/v2/gh/{{ cookiecutter.repository|replace("https://github.com/", "") }}/main?urlpath=lab) {%- endif %} {{ cookiecutter.project_short_description }} {% if cookiecutter.kind.lower() == 'server' %} This extension is composed of a Python package named {{ cookiecutter.python_name }} for the server extension and a NPM package named {{ cookiecutter.labextension_name }} for the frontend extension. {% endif %}

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install {{ cookiecutter.python_name }}

Uninstall

To remove the extension, execute:

pip uninstall {{ cookiecutter.python_name }}

{% if cookiecutter.kind.lower() == 'server' %}

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

{% endif %}

Contributing

Development install

Note: You will need NodeJS to build the extension package.

# Clone the repo to your local environment
# Change directory to the {{ cookiecutter.python_name }} directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite{% if cookiecutter.kind.lower() == 'server' %}
# Server extension must be manually installed in develop mode
jupyter server extension enable {{ cookiecutter.python_name }}{% endif %}
# Rebuild extension Typescript source after making changes
npm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

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

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the npm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable {{ cookiecutter.python_name }}{% endif %}
pip uninstall {{ cookiecutter.python_name }}

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named {{ cookiecutter.labextension_name }} within that folder.

Packaging the extension

See RELEASE