| Name | noworkflow-labextension JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension for noWorkflow |
| upload_time | 2024-08-22 23:57:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | The MIT License (MIT) Copyright (c) 2024 Universidade Federal Fluminense (UFF), New York University (NYU). Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# noworkflow_labextension
[](https://github.com/gems-uff/noworkflow/actions/workflows/build.yml)
A JupyterLab extension for noWorkflow
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install noworkflow_labextension
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall noworkflow_labextension
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
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
# Change directory to the noworkflow_labextension directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
npm run build
```
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.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
npm run watch
# Run JupyterLab in another terminal
jupyter lab
```
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 `npm 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
```
### Development uninstall
```bash
pip uninstall noworkflow_labextension
```
In development mode, 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 `@noworkflow/labextension` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "noworkflow-labextension",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Joao Felipe Pimentel <joaofelipenp@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/da/ea/b60dec6cb6ba91331efc2546be1938974cbeab1ba0ff696a55cacd3e7feb/noworkflow_labextension-0.1.0.tar.gz",
"platform": null,
"description": "# noworkflow_labextension\n\n[](https://github.com/gems-uff/noworkflow/actions/workflows/build.yml)\n\nA JupyterLab extension for noWorkflow\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install noworkflow_labextension\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall noworkflow_labextension\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\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# Change directory to the noworkflow_labextension directory\n# Install package in development mode\npip install -e \".\"\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\nnpm run build\n```\n\nYou 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.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\nnpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith 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).\n\nBy default, the `npm 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:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\npip uninstall noworkflow_labextension\n```\n\nIn development mode, you 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`\nfolder is located. Then you can remove the symlink named `@noworkflow/labextension` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2024 Universidade Federal Fluminense (UFF), New York University (NYU). Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A JupyterLab extension for noWorkflow",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/gems-uff/noworkflow/issues",
"Homepage": "https://github.com/gems-uff/noworkflow",
"Repository": "https://github.com/gems-uff/noworkflow.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3dbb6c68ac473e6fa089fcba61f63c9aad6b972b3d393200e3b3925fe19a173b",
"md5": "f90405ca5293c98d4cb1247fa5e89a9d",
"sha256": "fe5f5c32fb593cdc8d3b0d7e9651328f31986c4584bf5bfc4b3405a56c3458be"
},
"downloads": -1,
"filename": "noworkflow_labextension-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f90405ca5293c98d4cb1247fa5e89a9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 479261,
"upload_time": "2024-08-22T23:57:52",
"upload_time_iso_8601": "2024-08-22T23:57:52.728007Z",
"url": "https://files.pythonhosted.org/packages/3d/bb/6c68ac473e6fa089fcba61f63c9aad6b972b3d393200e3b3925fe19a173b/noworkflow_labextension-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "daeab60dec6cb6ba91331efc2546be1938974cbeab1ba0ff696a55cacd3e7feb",
"md5": "07b891d0791b7ea513c19c1634938be4",
"sha256": "fba4e1f4d6b2f904c0d6719c00e53fe03adedb3d171373ab476fcf33d95124d4"
},
"downloads": -1,
"filename": "noworkflow_labextension-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "07b891d0791b7ea513c19c1634938be4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 458856,
"upload_time": "2024-08-22T23:57:55",
"upload_time_iso_8601": "2024-08-22T23:57:55.258771Z",
"url": "https://files.pythonhosted.org/packages/da/ea/b60dec6cb6ba91331efc2546be1938974cbeab1ba0ff696a55cacd3e7feb/noworkflow_labextension-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 23:57:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gems-uff",
"github_project": "noworkflow",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "noworkflow-labextension"
}
