| Name | jupyter-builder JSON |
| Version |
0.1.0a3
JSON |
| download |
| home_page | None |
| Summary | JupyterLab build tools |
| upload_time | 2024-07-30 13:33:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Jupyter Development Team 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 |
ipython
jupyter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyter Builder - GSoC 2024
Build tools for JupyterLab (and remixes)
> This _will_ start as an extraction of the builder tools currently included in
> the core [JupyterLab](https://github.com/jupyterlab/jupyterlab).
## Why extracting the build tools?
- This would also solve some chicken-and-egg problems like jupyterlab/jupyterlab_pygments#23.
- Isolating the builder functionalities will simplify the work
of core and extension developers who can now focus on their respective parts of the
codebase instead of the earlier intertwined code. It will in particular reduce the need to update the maintenance tooling to produce extension compatible with newer version of Jupyter app.
## How to install the package?
Execute the following command in a terminal:
```
pip install jupyter_builder
```
## What does it do?
- Provides a CLI for building Jupyter extensions. There are 3 subcommands
- `build` : Builds the Jupyter extension JavaScript assets to be consumed by the Jupyter app.
```
jupyter-builder build <path to extension folder>
```
- `develop` : Install the Jupyter extension JavaScript assets in dev mode for consumption in the Jupyter app. It similar to [editable install mode of pip](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs)
```
jupyter-builder develop --overwrite (path to extension folder)
```
- `watch` : Automatically rebuild the development JavaScript assets when one file is changed to ease development.
```
jupyter-builder watch (path to extension folder)
```
- Provides a NPM package manager: `jlpm`
## How to uninstall the package?
Execute the following command in a terminal:
```
pip uninstall jupyter_builder
```
See https://github.com/jupyterlab/jupyterlab/issues/13456
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-builder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ipython, jupyter",
"author": null,
"author_email": "Jupyter Development Team <jupyter@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/52/14/1b6ff974440d2bec597d5b887702ef71aad87c743a09f2eb588deee02c72/jupyter_builder-0.1.0a3.tar.gz",
"platform": null,
"description": "# Jupyter Builder - GSoC 2024\n\nBuild tools for JupyterLab (and remixes)\n\n> This _will_ start as an extraction of the builder tools currently included in\n> the core [JupyterLab](https://github.com/jupyterlab/jupyterlab).\n\n## Why extracting the build tools?\n\n- This would also solve some chicken-and-egg problems like jupyterlab/jupyterlab_pygments#23.\n- Isolating the builder functionalities will simplify the work\n of core and extension developers who can now focus on their respective parts of the\n codebase instead of the earlier intertwined code. It will in particular reduce the need to update the maintenance tooling to produce extension compatible with newer version of Jupyter app.\n\n## How to install the package?\n\nExecute the following command in a terminal:\n\n```\npip install jupyter_builder\n```\n\n## What does it do?\n\n- Provides a CLI for building Jupyter extensions. There are 3 subcommands\n - `build` : Builds the Jupyter extension JavaScript assets to be consumed by the Jupyter app.\n ```\n jupyter-builder build <path to extension folder>\n ```\n - `develop` : Install the Jupyter extension JavaScript assets in dev mode for consumption in the Jupyter app. It similar to [editable install mode of pip](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs)\n ```\n jupyter-builder develop --overwrite (path to extension folder)\n ```\n - `watch` : Automatically rebuild the development JavaScript assets when one file is changed to ease development.\n ```\n jupyter-builder watch (path to extension folder)\n ```\n- Provides a NPM package manager: `jlpm`\n\n## How to uninstall the package?\n\nExecute the following command in a terminal:\n\n```\npip uninstall jupyter_builder\n```\n\nSee https://github.com/jupyterlab/jupyterlab/issues/13456\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Jupyter Development Team 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": "JupyterLab build tools",
"version": "0.1.0a3",
"project_urls": {
"Gitter": "https://gitter.im/jupyterlab/jupyterlab",
"Homepage": "https://jupyter.org",
"Issues": "https://github.com/jupyterlab/jupyterlab_builder/issues/new/choose",
"Pypi": "https://pypi.org/project/jupyter-builder",
"Source": "https://github.com/jupyterlab/jupyterlab_builder"
},
"split_keywords": [
"ipython",
" jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c184bd8da24095a1a127911f844a8c2c6a4d0cd0e3353a20af49ad938ce917c",
"md5": "120c71ad9a2929b1b2e5293d47f3c7a2",
"sha256": "22282803dcab260bf2027ea185ddd5727ec242c17127a2aef40020a934699904"
},
"downloads": -1,
"filename": "jupyter_builder-0.1.0a3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "120c71ad9a2929b1b2e5293d47f3c7a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 896344,
"upload_time": "2024-07-30T13:33:23",
"upload_time_iso_8601": "2024-07-30T13:33:23.993924Z",
"url": "https://files.pythonhosted.org/packages/6c/18/4bd8da24095a1a127911f844a8c2c6a4d0cd0e3353a20af49ad938ce917c/jupyter_builder-0.1.0a3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "52141b6ff974440d2bec597d5b887702ef71aad87c743a09f2eb588deee02c72",
"md5": "916b87a8e5e9f6505fefb5e98002ce4c",
"sha256": "18fe752d733f9776b409a2b21737773f0ebb0766c831d50c763ada7571076f1b"
},
"downloads": -1,
"filename": "jupyter_builder-0.1.0a3.tar.gz",
"has_sig": false,
"md5_digest": "916b87a8e5e9f6505fefb5e98002ce4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 928394,
"upload_time": "2024-07-30T13:33:27",
"upload_time_iso_8601": "2024-07-30T13:33:27.769532Z",
"url": "https://files.pythonhosted.org/packages/52/14/1b6ff974440d2bec597d5b887702ef71aad87c743a09f2eb588deee02c72/jupyter_builder-0.1.0a3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 13:33:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlab",
"github_project": "jupyterlab_builder",
"github_not_found": true,
"lcname": "jupyter-builder"
}
