jupyterlab-commenting v0.1.0

Installation | Development | License | Team | Getting help |

JupyterLab Commenting and Annotation

Project Vision

We have articulated our vision for this project as a "Press Release from the Future". We are now pursing that vision to make it a reality. Have feedback or want to get involved? Post an issue!

Usage

Check out the Usage Guide to learn about the features this extension offers.

Prerequisites

• JupyterLab

Installation

jupyter labextension install jupyterlab-commenting

Development

For a development install (requires npm version 4 or later), do the following in the repository directory:

npm install
npm run build
jupyter labextension link .

To rebuild the package and the JupyterLab app:

npm run build
jupyter lab build

JupyterLab master

To develop against an unreleased version of JupyterLab requires that you add this extension as a package inside the jupyterlab repo:

conda create -n jupyterlab-commenting -c conda-forge jupyterlab nodejs

git clone https://github.com/jupyterlab/jupyterlab.git jupyterlab-commenting

cd jupyterlab-commenting

conda activate jupyterlab-commenting
pip install -e .

jlpm run add:sibling https://github.com/jupyterlab/jupyterlab-commenting.git
jlpm run build

Edit the files in the package in ./packages/jupterlab-commenting and run jupyter lab --watch --dev in the top level directory to run JupyterLab with this package enabled.

Contributing

To contribute to the project, please read the contributor documentation.

JupyterLab Commenting and Annotation follows the Jupyter Community Guides.

License

JupyterLab Commenting and Annotation uses a shared copyright model that enables all contributors to maintain the copyright on their contributions. All code is licensed under the terms of the revised BSD license.

Team

JupyterLab Commenting Extension is part of Project Jupyter and is developed by an open community.

Current maintainers of this project are listed in alphabetical order, with affiliation, and main areas of contribution:

• Brian Granger, Cal Poly (co-creator, strategy, vision, management, UI/UX design, architecture).
• Igor Derke, Quansight (general development, extensions)
• Ivan Ogasawara, Quansight (general development, extensions)
• Jacob Houssian, Quansight (general development, extensions)
• Katherine Oliphant, Quansight (general development, extensions)
• Ryan Henning, Quansight (management)
• Saul Shanabrook, Quansight (general development, extensions)
• Tim George, Cal Poly (UI/UX design, strategy, management, user needs analysis)

Getting help

We encourage you to ask questions on the mailing list, and participate in development discussions or get live help on Gitter. Please use the issues page to provide feedback or submit a bug report.