jupyter-wysiwyg

Name	jupyter-wysiwyg JSON
Version	23.3.0 JSON
	download
home_page
Summary	WYSIWYG editing functionality for markdown/HTML cells in Jupyter
upload_time	2023-03-29 16:45:52
maintainer
docs_url	None
author
requires_python	>=3.6
license	BSD 3-Clause License Copyright (c) 2015-2021, Regents of the University of California & Broad Institute All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords	jupyter jupyterlab jupyterlab3
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

# Rich Text HTML/Markdown Editor for JupyterLab

This is an nbextension that enables WYSIWYG editing functionality for HTML/Markdown cells in Jupyter.

## Requirements

* JupyterLab >= 3.0
* ipywidgets >= 7.0.0

## Installing

This extension can be installed through PIP.

```bash
pip install jupyter-wysiwyg
```

***OR***

```bash
# Clone the jupyter-wysiwyg repository
git clone https://github.com/g2nb/jupyter-wysiwyg.git
cd jupyter-wysiwyg

# Install the jupyter-wysiwyg JupyterLab prototype
pip install -e .
jupyter labextension develop . --overwrite
```

## Development

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. To develop, run each of the following commands in a
separate terminal.

```bash
jlpm run watch
jupyter lab
```

The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You
may use `yarn` or `npm` in lieu of `jlpm`.

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

```bash
jupyter lab build --minimize=False
```

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "jupyter-wysiwyg",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "Jupyter,JupyterLab,JupyterLab3",
    "author": "",
    "author_email": "Thorin Tabor <tmtabor@cloud.ucsd.edu>",
    "download_url": "https://files.pythonhosted.org/packages/5f/7c/d8eb69b089d8f44b60f54ce2ab574ee341eea3f85774ce585429c23795f6/jupyter_wysiwyg-23.3.0.tar.gz",
    "platform": null,
    "description": "# Rich Text HTML/Markdown Editor for JupyterLab\n\nThis is an nbextension that enables WYSIWYG editing functionality for HTML/Markdown cells in Jupyter.\n\n## Requirements\n\n* JupyterLab >= 3.0\n* ipywidgets >= 7.0.0\n\n## Installing\n\nThis extension can be installed through PIP.\n\n```bash\npip install jupyter-wysiwyg\n```\n\n***OR***\n\n```bash\n# Clone the jupyter-wysiwyg repository\ngit clone https://github.com/g2nb/jupyter-wysiwyg.git\ncd jupyter-wysiwyg \n\n# Install the jupyter-wysiwyg JupyterLab prototype\npip install -e .\njupyter labextension develop . --overwrite\n```\n\n## Development\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in \nthe extension's source and automatically rebuild the extension. To develop, run each of the following commands in a \nseparate terminal. \n\n```bash\njlpm run watch\njupyter lab\n```\n\nThe `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You \nmay use `yarn` or `npm` in lieu of `jlpm`.\n\nWith the watch command running, every saved change will immediately be built locally and available in your running \nJupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the \nextension to be rebuilt).\n\nBy default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using \nthe browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2015-2021, Regents of the University of California & Broad Institute All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
    "summary": "WYSIWYG editing functionality for markdown/HTML cells in Jupyter",
    "version": "23.3.0",
    "split_keywords": [
        "jupyter",
        "jupyterlab",
        "jupyterlab3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b398fade7b76e5f80c269faecc2ec33736542e0f33c40cabd418ed95aff2455b",
                "md5": "d5ce06c25b76a2efe4a688c092a187b4",
                "sha256": "08a147a74b78e0756a0bc27250117578d183f820506d2519ab42d2e63dd9126c"
            },
            "downloads": -1,
            "filename": "jupyter_wysiwyg-23.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d5ce06c25b76a2efe4a688c092a187b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 805915,
            "upload_time": "2023-03-29T16:45:55",
            "upload_time_iso_8601": "2023-03-29T16:45:55.015494Z",
            "url": "https://files.pythonhosted.org/packages/b3/98/fade7b76e5f80c269faecc2ec33736542e0f33c40cabd418ed95aff2455b/jupyter_wysiwyg-23.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5f7cd8eb69b089d8f44b60f54ce2ab574ee341eea3f85774ce585429c23795f6",
                "md5": "d101be16a1a61fce14f829c503c86f42",
                "sha256": "d1a96921b52f90473797833f2fc64148d89b094df89960da6af4715d10dc696f"
            },
            "downloads": -1,
            "filename": "jupyter_wysiwyg-23.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d101be16a1a61fce14f829c503c86f42",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 406586,
            "upload_time": "2023-03-29T16:45:52",
            "upload_time_iso_8601": "2023-03-29T16:45:52.372484Z",
            "url": "https://files.pythonhosted.org/packages/5f/7c/d8eb69b089d8f44b60f54ce2ab574ee341eea3f85774ce585429c23795f6/jupyter_wysiwyg-23.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-29 16:45:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "jupyter-wysiwyg"
}