Skip to main content

Q# extension for JupyterLab

Reason this release was yanked:

Superseded

Project description

Q# extension for JupyterLab

Prerequisites

You will need to install jupyterlab to build and develop the extension.

pip install jupyterlab==4.0.0

A note about yarn

The jlpm command used below is an alias for yarn which comes bundled with Jupyter.

This folder is not part of the npm workspace that is defined at the root of this repo. This is intentional, since Jupyter extension tooling depends on jlpm, which expects a yarn-style workspace and a yarn.lock file.

Building

To build and install the extension in development mode, from the jupyterlab directory run:

pip install -e .
# The below command creates a symlink from JupyterLab's
# extensions directory to the current source directory.
jupyter labextension develop . --overwrite

To start JupyterLab and use the extension, run:

jupyter lab

To rebuild after making source changes, run:

jlpm build

Then refresh the browser.

Uninstalling

Remove the pip package by running:

pip uninstall qsharp-jupyterlab

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 qsharp-jupyterlab within that folder.

Releasing

The extension can be published to PyPI and npm manually or using the Jupyter Releaser.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

qsharp_jupyterlab-0.0.9-py3-none-any.whl (11.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page