| Name | jupyterlite-terminal JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A terminal for JupyterLite |
| upload_time | 2024-09-16 11:51:49 |
| maintainer | None |
| docs_url | None |
| author | JupyterLite Contributors |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c), Ian Thomas Copyright (c), JupyterLite Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. 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.
|
# jupyterlite-terminal
[](https://github.com/jupyterlite/terminal/actions/workflows/build.yml)
[](https://jupyterlite.github.io/terminal/lab/index.html)
A terminal for JupyterLite.
⚠️ This extension is still in development and not yet ready for general use. ⚠️
## Requirements
- JupyterLite >= 0.4.0
## Install
To install the extension, execute:
```bash
pip install jupyterlite-terminal
```
You will also need to install the JupyterLite CLI:
```bash
python -m pip install --pre jupyterlite-core
```
## Usage
After installing `jupyterlite-core` and `jupyterlite-terminal`, create a `jupyter-lite.json` file with the following content to activate the terminal extension:
```json
{
"jupyter-lite-schema-version": 0,
"jupyter-config-data": {
"terminalsAvailable": true
}
}
```
Then build a new JupyterLite site:
```bash
jupyter lite build
```
## 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 jupyterlite_terminal 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
jlpm 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
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
Then build a JupyterLite distribution with the extension installed:
```bash
jupyter lite build
```
And serve it:
```bash
jupyter lite serve
```
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlite-terminal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "JupyterLite Contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/56/ec/ff5e30c4ad2abe136980ed40a92772ca9430125af702f6f5d27944e88ae6/jupyterlite_terminal-0.1.1.tar.gz",
"platform": null,
"description": "# jupyterlite-terminal\n\n[](https://github.com/jupyterlite/terminal/actions/workflows/build.yml)\n[](https://jupyterlite.github.io/terminal/lab/index.html)\n\nA terminal for JupyterLite.\n\n\u26a0\ufe0f This extension is still in development and not yet ready for general use. \u26a0\ufe0f\n\n\n\n## Requirements\n\n- JupyterLite >= 0.4.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlite-terminal\n```\n\nYou will also need to install the JupyterLite CLI:\n\n```bash\npython -m pip install --pre jupyterlite-core\n```\n\n## Usage\n\nAfter installing `jupyterlite-core` and `jupyterlite-terminal`, create a `jupyter-lite.json` file with the following content to activate the terminal extension:\n\n```json\n{\n \"jupyter-lite-schema-version\": 0,\n \"jupyter-config-data\": {\n \"terminalsAvailable\": true\n }\n}\n```\n\nThen build a new JupyterLite site:\n\n```bash\njupyter lite build\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 jupyterlite_terminal 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\njlpm 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\njlpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nThen build a JupyterLite distribution with the extension installed:\n\n```bash\njupyter lite build\n```\n\nAnd serve it:\n\n```bash\njupyter lite serve\n```\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c), Ian Thomas Copyright (c), JupyterLite Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. 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 terminal for JupyterLite",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlite/terminal/issues",
"Homepage": "https://github.com/jupyterlite/terminal",
"Repository": "https://github.com/jupyterlite/terminal.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "00395e363e491a82f1c9d5e3669206c7738914f3f30bce9c85c3f762c935154a",
"md5": "68327ecc2dd57fca7ef9b1f728aa73a2",
"sha256": "fe4287cb074afadddfd7eb42d359d47134e5bbe574e636fe053f7f0ec592dbf9"
},
"downloads": -1,
"filename": "jupyterlite_terminal-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68327ecc2dd57fca7ef9b1f728aa73a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1148503,
"upload_time": "2024-09-16T11:51:46",
"upload_time_iso_8601": "2024-09-16T11:51:46.707987Z",
"url": "https://files.pythonhosted.org/packages/00/39/5e363e491a82f1c9d5e3669206c7738914f3f30bce9c85c3f762c935154a/jupyterlite_terminal-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56ecff5e30c4ad2abe136980ed40a92772ca9430125af702f6f5d27944e88ae6",
"md5": "9d68c3764c9aac4fc7587204fe7fd320",
"sha256": "c4a92668991f39b06580d3b7280672156905f6709f832dd825aa24d627ce0b67"
},
"downloads": -1,
"filename": "jupyterlite_terminal-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9d68c3764c9aac4fc7587204fe7fd320",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1264407,
"upload_time": "2024-09-16T11:51:49",
"upload_time_iso_8601": "2024-09-16T11:51:49.731551Z",
"url": "https://files.pythonhosted.org/packages/56/ec/ff5e30c4ad2abe136980ed40a92772ca9430125af702f6f5d27944e88ae6/jupyterlite_terminal-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 11:51:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlite",
"github_project": "terminal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlite-terminal"
}
