| Name | appmode-jupyterlab JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension for Appmode. |
| upload_time | 2024-05-16 12:19:25 |
| maintainer | None |
| docs_url | None |
| author | Dou Du |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2020, Dou Du 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# appmode-jupyterlab
A JupyterLab extension for Appmode (https://github.com/oschuett/appmode).
This extension is created from the modification of the voila JupyterLab extension code
(https://github.com/voila-dashboards/voila).
## Requirements
* JupyterLab >= 4.0
## Install
```bash
pip install appmode-jupyterlab
```
## Contributing
### Install
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 appmode-jupyterlab directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# 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
```
Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
### Uninstall
```bash
jupyter labextension uninstall @osscar/appmode-jupyterlab
```
## Acknowledgements
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": null,
"name": "appmode-jupyterlab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Dou Du",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/dc/eb/9c59d19e3d95aa06a227d4b3c093c4bc4c4a16471fba8b46757f3b1a2563/appmode_jupyterlab-1.0.0.tar.gz",
"platform": null,
"description": "# appmode-jupyterlab\n\n\n\nA JupyterLab extension for Appmode (https://github.com/oschuett/appmode). \nThis extension is created from the modification of the voila JupyterLab extension code\n(https://github.com/voila-dashboards/voila).\n\n\n\n## Requirements\n\n* JupyterLab >= 4.0\n\n## Install\n\n```bash\npip install appmode-jupyterlab\n```\n\n## Contributing\n\n### Install\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 appmode-jupyterlab directory\n\n# Install dependencies\njlpm\n# Build Typescript source\njlpm build\n# Link your development version of the extension with JupyterLab\njupyter labextension install .\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\nNow every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).\n\n### Uninstall\n\n```bash\n\njupyter labextension uninstall @osscar/appmode-jupyterlab\n```\n\n## Acknowledgements\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 License Copyright (c) 2020, Dou Du 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": "A JupyterLab extension for Appmode.",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/osscar-org/appmode-jupyterlab/issues",
"Homepage": "https://github.com/osscar-org/appmode-jupyterlab",
"Repository": "https://github.com/osscar-org/appmode-jupyterlab.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3db0f787b72acca5f3f94893b7063c10456697045cbb8296fb0f3a7fa3e5e250",
"md5": "424c9a09dc231de9dede339fbd4c31eb",
"sha256": "17b50fdd152d116aad2d8c45d70eb145a4a1e307607a8c2233e2e7935dfd67c0"
},
"downloads": -1,
"filename": "appmode_jupyterlab-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "424c9a09dc231de9dede339fbd4c31eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24098,
"upload_time": "2024-05-16T12:19:22",
"upload_time_iso_8601": "2024-05-16T12:19:22.250272Z",
"url": "https://files.pythonhosted.org/packages/3d/b0/f787b72acca5f3f94893b7063c10456697045cbb8296fb0f3a7fa3e5e250/appmode_jupyterlab-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dceb9c59d19e3d95aa06a227d4b3c093c4bc4c4a16471fba8b46757f3b1a2563",
"md5": "647d3da638030e89f66b73e0298d18aa",
"sha256": "bf85c6b3b5c3d8dcceb89cab18b734c2ed53a7ef769898e0d6b56350e5adf4cb"
},
"downloads": -1,
"filename": "appmode_jupyterlab-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "647d3da638030e89f66b73e0298d18aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 132191,
"upload_time": "2024-05-16T12:19:25",
"upload_time_iso_8601": "2024-05-16T12:19:25.337797Z",
"url": "https://files.pythonhosted.org/packages/dc/eb/9c59d19e3d95aa06a227d4b3c093c4bc4c4a16471fba8b46757f3b1a2563/appmode_jupyterlab-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 12:19:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osscar-org",
"github_project": "appmode-jupyterlab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "appmode-jupyterlab"
}
