qsharp_jupyterlab

Name	qsharp_jupyterlab JSON
Version	0.0.7 JSON
	download
home_page	None
Summary	Q# extension for JupyterLab
upload_time	2023-08-13 23:24:37
maintainer	None
docs_url	None
author	Microsoft
requires_python	>=3.7
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Q# extension for JupyterLab

## Prerequisites

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

```bash
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:

```bash
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:

```bash
jupyter lab
```

To rebuild after making source changes, run:

```bash
jlpm build
```

Then refresh the browser.

## Uninstalling

Remove the `pip` package by running:

```bash
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](https://github.com/jupyter-server/jupyter_releaser).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "qsharp_jupyterlab",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "Microsoft",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# Q# extension for JupyterLab\n\n## Prerequisites\n\nYou will need to install `jupyterlab` to build and develop the extension.\n\n```bash\npip install jupyterlab==4.0.0\n```\n\n## A note about `yarn`\n\nThe `jlpm` command used below is an alias for `yarn` which comes bundled with Jupyter.\n\nThis folder is not part of the `npm` workspace that is defined at the root of this repo.\nThis is intentional, since Jupyter extension tooling depends on `jlpm`, which expects a\n`yarn`-style workspace and a `yarn.lock` file.\n\n## Building\n\nTo build and install the extension in development mode, from the `jupyterlab` directory run:\n\n```bash\npip install -e .\n# The below command creates a symlink from JupyterLab's\n# extensions directory to the current source directory.\njupyter labextension develop . --overwrite\n```\n\nTo start JupyterLab and use the extension, run:\n\n```bash\njupyter lab\n```\n\nTo rebuild after making source changes, run:\n\n```bash\njlpm build\n```\n\nThen refresh the browser.\n\n## Uninstalling\n\nRemove the `pip` package by running:\n\n```bash\npip uninstall qsharp_jupyterlab\n```\n\nYou will also need to remove the symlink created by `jupyter labextension develop`\ncommand. 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.\n\n## Releasing\n\nThe extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Q# extension for JupyterLab",
    "version": "0.0.7",
    "project_urls": {
        "Bug Tracker": "https://github.com/microsoft/qsharp/issues",
        "Homepage": "https://github.com/microsoft/qsharp",
        "Repository": "https://github.com/microsoft/qsharp.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ca5a1edc163b57a2f8270c089a8103922fc270a82236c828d924848a4b557d48",
                "md5": "1eb976dce55d3830ea66547df3390028",
                "sha256": "e196ad0f05d7ff9aa7d719f7df44c7619f01e63e1f9313af0a6c6697da3e1451"
            },
            "downloads": -1,
            "filename": "qsharp_jupyterlab-0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1eb976dce55d3830ea66547df3390028",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 10994,
            "upload_time": "2023-08-13T23:24:37",
            "upload_time_iso_8601": "2023-08-13T23:24:37.061750Z",
            "url": "https://files.pythonhosted.org/packages/ca/5a/1edc163b57a2f8270c089a8103922fc270a82236c828d924848a4b557d48/qsharp_jupyterlab-0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-13 23:24:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "microsoft",
    "github_project": "qsharp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "qsharp_jupyterlab"
}