| Name | jupyter-cgi-theme JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | The JupyterLab CGI theme |
| upload_time | 2024-12-19 12:17:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Davide Giorgiutti 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 |
cgi
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyter_cgi_theme <https://pypi.org/project/jupyter-cgi-theme/>
The JupyterLab CGI theme.
An extension for JupyterLab, published as a PIP package, adds two CGI-branded themes (light and dark) and some UI elements.
This project was initialized using a copier template for Jupyterlab extensions: <https://github.com/jupyterlab/extension-template>.
## Development Requirements
To initialize a working development environment, ensure you have the following installed on your machine:
- Node
- npm
- Yarn
- pip
- Python
- JupyterLab
The local development environment uses the following versions:
- Node: 20.12.2
- npm: 10.5.0
- pip: 24.2
- Python: 3.11.3
- JupyterLab: 4.2.4
The template used to create this extension suggests using:
- JupyterLab >= 4.0.0
## Install the published package (production use)
⚠️ **Note:** Your extensions may break with new releases of JupyterLab. As noted in Backwards Compatibility, Versions and Breaking Changes, JupyterLab development and release cycles follow semantic versioning, so we recommend planning your development process to account for possible future breaking changes that may disrupt users of your extensions. Consider documenting your maintenance plans to users in your project, or setting an upper bound on the version of JupyterLab your extension is compatible with in your project’s package metadata.
<https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html>
To install the extension, execute:
```bash
pip install jupyter_cgi_theme
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyter_cgi_theme
```
## Development
### 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` instead of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the jupyter_cgi_theme directory
# Install package in development mode
pip install -e "."
# Install js packages
jlpm install
# 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 simultaneously 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
```
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 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 jupyter_cgi_theme
```
In development mode, you will also need to remove the symlink created by the `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 `jupyter-cgi-theme` within that folder.
## Packaging and releasing the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-cgi-theme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "CGI, jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Davide Giorgiutti <davide.giorgiutti@cgi.com>",
"download_url": "https://files.pythonhosted.org/packages/ef/94/82748e65bb60308faf878efa1b2a42c95127daa89d66eac3dd5665730905/jupyter_cgi_theme-1.1.0.tar.gz",
"platform": null,
"description": "# jupyter_cgi_theme <https://pypi.org/project/jupyter-cgi-theme/>\n\nThe JupyterLab CGI theme.\nAn extension for JupyterLab, published as a PIP package, adds two CGI-branded themes (light and dark) and some UI elements.\n\nThis project was initialized using a copier template for Jupyterlab extensions: <https://github.com/jupyterlab/extension-template>.\n\n## Development Requirements\n\nTo initialize a working development environment, ensure you have the following installed on your machine:\n\n- Node\n- npm\n- Yarn\n- pip\n- Python\n- JupyterLab\n\nThe local development environment uses the following versions:\n\n- Node: 20.12.2\n- npm: 10.5.0\n- pip: 24.2\n- Python: 3.11.3\n- JupyterLab: 4.2.4\n\nThe template used to create this extension suggests using:\n\n- JupyterLab >= 4.0.0\n\n## Install the published package (production use)\n\n\u26a0\ufe0f **Note:** Your extensions may break with new releases of JupyterLab. As noted in Backwards Compatibility, Versions and Breaking Changes, JupyterLab development and release cycles follow semantic versioning, so we recommend planning your development process to account for possible future breaking changes that may disrupt users of your extensions. Consider documenting your maintenance plans to users in your project, or setting an upper bound on the version of JupyterLab your extension is compatible with in your project\u2019s package metadata.\n\n<https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html>\n\nTo install the extension, execute:\n\n```bash\npip install jupyter_cgi_theme\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyter_cgi_theme\n```\n\n## Development\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 [yarn](https://yarnpkg.com/) that is installed with JupyterLab.\n\nYou may use `yarn` or `npm` instead of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyter_cgi_theme directory\n\n# Install package in development mode\npip install -e \".\"\n\n# Install js packages\njlpm install\n\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n\n# Rebuild extension Typescript source after making changes\njlpm build\n```\n\nYou can watch the source directory and run JupyterLab simultaneously 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\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 `jlpm 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 jupyter_cgi_theme\n```\n\nIn development mode, you will also need to remove the symlink created by the `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 `jupyter-cgi-theme` within that folder.\n\n## Packaging and releasing the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Davide Giorgiutti 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": "The JupyterLab CGI theme",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/davideCGI/jupyter-cgi-theme/issues",
"Homepage": "https://github.com/davideCGI/jupyter-cgi-theme",
"Repository": "https://github.com/davideCGI/jupyter-cgi-theme.git"
},
"split_keywords": [
"cgi",
" jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dd0e97e94b6054de5aa58d995a439462ecd7fa4be5c5f9c7e3349019c28ec66",
"md5": "68054ddf536dabff0e667e9f510f0267",
"sha256": "5c7f7e9e19ee084ce20c8f1bd9f69e8115b5c62f9104c80345af9c391f3e972a"
},
"downloads": -1,
"filename": "jupyter_cgi_theme-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68054ddf536dabff0e667e9f510f0267",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 79337,
"upload_time": "2024-12-19T12:17:45",
"upload_time_iso_8601": "2024-12-19T12:17:45.265359Z",
"url": "https://files.pythonhosted.org/packages/6d/d0/e97e94b6054de5aa58d995a439462ecd7fa4be5c5f9c7e3349019c28ec66/jupyter_cgi_theme-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef9482748e65bb60308faf878efa1b2a42c95127daa89d66eac3dd5665730905",
"md5": "2ea906444552850266f4e12b62ad15e5",
"sha256": "a5d63d8fe9cb52896773cef0b57a91c1bf16085e82866a4b2db16555f2f9c05e"
},
"downloads": -1,
"filename": "jupyter_cgi_theme-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2ea906444552850266f4e12b62ad15e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 268363,
"upload_time": "2024-12-19T12:17:46",
"upload_time_iso_8601": "2024-12-19T12:17:46.877039Z",
"url": "https://files.pythonhosted.org/packages/ef/94/82748e65bb60308faf878efa1b2a42c95127daa89d66eac3dd5665730905/jupyter_cgi_theme-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 12:17:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davideCGI",
"github_project": "jupyter-cgi-theme",
"github_not_found": true,
"lcname": "jupyter-cgi-theme"
}
