diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c3e7ad..41edc6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,16 @@ # Contributing +## Install Dependencies + +```shell +pip install hatch hatch-nodejs-version pytest pytest_jupyter ruff +``` + ## JupyterLab Extension ### Development install + Note: You will need `NodeJS` to build the extension package. Recommend use `pnpm` ```bash @@ -17,7 +24,8 @@ jupyter labextension develop . --overwrite pnpm 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. +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. ```bash # Watch the source directory in one terminal, automatically rebuilding when needed @@ -26,9 +34,11 @@ pnpm watch 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). +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 `pnpm 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: +By default, the `pnpm 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: ```bash jupyter lab build --minimize=False @@ -60,7 +70,8 @@ pnpm test #### Integration tests This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests). -More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab. +More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to +handle testing the extension in JupyterLab. More information are provided within the [ui-tests](./ui-tests/README.md) README. diff --git a/package.json b/package.json index 339c310..2982d71 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "neopyter", - "version": "0.2.2", + "version": "0.2.3", "description": "A JupyterLab extension. Integrate JupyterLab and Neovim", "workspaces": [ "ui-tests"