abirami-hide-code


Nameabirami-hide-code JSON
Version 4.0.5 PyPI version JSON
download
home_page
SummaryA JupyterLab extension to run and hide source code.
upload_time2023-09-04 19:05:07
maintainer
docs_urlNone
authorDou Du
requires_python>=3.7
licenseBSD-3-Clause
keywords jupyter jupyterlab jupyterlab3
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # **jupyterlab-hide-code**: A JupyterLab Extension to Run and Hide Source Code

![Build](https://github.com/osscar-org/jupyterlab-hide-code/workflows/Build/badge.svg)
[![PyPI version](https://badge.fury.io/py/jupyterlab-hide-code.svg)](https://badge.fury.io/py/jupyterlab-hide-code)

A button in JupyterLab to run the code cells and then to hide the code cells.
This JupyterLab extension was inspired by the
[jlab-hide-code](https://github.com/AixViPMaP/jlab-hide-code) JupyterLab
extension from Aachen (Aix) Virtual Platform for Materials Processing.

![demo](./docs/hide-input.gif)

## Requirements

- JupyterLab >= 3.0

## Install

```bash
pip install jupyterlab-hide-code
```

## Uninstall

```bash
pip uninstall jupyterlab-hide-code
```

## Contributing

### Build

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` below.

```bash
# Clone the repo to your local environment
# Move to jupyterlab-hide-code directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```

## Acknowlegements

We acknowledge support from the EPFL Open Science Fund via the [OSSCAR](http://www.osscar.org) project.

<img src='https://www.osscar.org/_images/logos.png' width='700'>

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "abirami-hide-code",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "Jupyter,JupyterLab,JupyterLab3",
    "author": "Dou Du",
    "author_email": "dou.du@epfl.ch",
    "download_url": "",
    "platform": "Linux",
    "description": "# **jupyterlab-hide-code**: A JupyterLab Extension to Run and Hide Source Code\n\n![Build](https://github.com/osscar-org/jupyterlab-hide-code/workflows/Build/badge.svg)\n[![PyPI version](https://badge.fury.io/py/jupyterlab-hide-code.svg)](https://badge.fury.io/py/jupyterlab-hide-code)\n\nA button in JupyterLab to run the code cells and then to hide the code cells.\nThis JupyterLab extension was inspired by the\n[jlab-hide-code](https://github.com/AixViPMaP/jlab-hide-code) JupyterLab\nextension from Aachen (Aix) Virtual Platform for Materials Processing.\n\n![demo](./docs/hide-input.gif)\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Install\n\n```bash\npip install jupyterlab-hide-code\n```\n\n## Uninstall\n\n```bash\npip uninstall jupyterlab-hide-code\n```\n\n## Contributing\n\n### Build\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Move to jupyterlab-hide-code directory\n# Install dependencies\njlpm\n# Build Typescript source\njlpm build\n# Link your development version of the extension with JupyterLab\njupyter labextension link .\n# Rebuild Typescript source after making changes\njlpm build\n# Rebuild JupyterLab after making any changes\njupyter lab build\n```\n\nYou can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.\n\n```bash\n# Watch the source directory in another terminal tab\njlpm watch\n# Run jupyterlab in watch mode in one terminal tab\njupyter lab --watch\n```\n\n## Acknowlegements\n\nWe acknowledge support from the EPFL Open Science Fund via the [OSSCAR](http://www.osscar.org) project.\n\n<img src='https://www.osscar.org/_images/logos.png' width='700'>\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "A JupyterLab extension to run and hide source code.",
    "version": "4.0.5",
    "project_urls": null,
    "split_keywords": [
        "jupyter",
        "jupyterlab",
        "jupyterlab3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3b259fe7a25c6345929bb60fa159c56620d4c981c46498344e5775d048bc365",
                "md5": "fcd5b8ad60982476a72ae01c0574ee60",
                "sha256": "3b19559b293d22ba901610c891b531d5f2d7f6e5ebf674af4d109548501c9ed5"
            },
            "downloads": -1,
            "filename": "abirami_hide_code-4.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fcd5b8ad60982476a72ae01c0574ee60",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 40820,
            "upload_time": "2023-09-04T19:05:07",
            "upload_time_iso_8601": "2023-09-04T19:05:07.734756Z",
            "url": "https://files.pythonhosted.org/packages/b3/b2/59fe7a25c6345929bb60fa159c56620d4c981c46498344e5775d048bc365/abirami_hide_code-4.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-04 19:05:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "abirami-hide-code"
}
Dou Du
Elapsed time: 0.61744s