| Name | jupyterlab-datalogs JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | JupyterLab extension for DataLogs. |
| upload_time | 2024-08-29 20:36:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2023–2024, California Institute of Technology 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 |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JupyterLab DataLogs
[](https://pypi.org/project/jupyterlab-datalogs/)
[](https://pypi.org/project/jupyterlab-datalogs/)
[](https://github.com/PainterQubits/jupyterlab-datalogs/blob/main/LICENSE)
[](https://github.com/PainterQubits/jupyterlab-datalogs/actions/workflows/ci.yml)
JupyterLab extension for DataLogs.
## Installation
Install the latest version of JupyterLab DataLogs using pip:
```
pip install -U jupyterlab-datalogs
```
This extension should run alongside
[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)
version 4 (included with the `jupyterlab` extra). There are also a set of packages
required for analysis using DataLogs notebooks (included with the `analysis` extra), and
a set of recommended JupyterLab plugins (included with the `plugins` extra).
To automatically install with all of these extras, use the `all` extra:
```
pip install -U "jupyterlab-datalogs[all]"
```
While the Real-Time Collaboration extension is included in the `plugins` extra for
[JupyterLab Open Warning](https://github.com/PainterQubits/jupyterlab-open-warning) to
work, the collaboration functionality can be disabled by running JupyterLab with the
following option:
```
jupyter lab --YDocExtension.disable_rtc True
```
## Development
To develop, the following dependencies must be installed:
- [Node.js](https://nodejs.org/en/download)
- [Yarn](https://yarnpkg.com/getting-started/install)
- [Python](https://www.python.org/downloads/)
- [Hatch](https://hatch.pypa.io/latest/install/)
Then, run
```bash
hatch run ci:jlpm
```
to install Node.js dependencies, and
```bash
hatch run dev
```
to build the extension and start up a JupyterLab server. The first time you do this, also
go to the Extension Manager tab in JupyterLab (the puzzle piece icon on the left) to
enable 3rd party extensions. Now the extension should be activated. When the source code
changes, it should automatically rebuild, and the updated extension will be used when the
page is reloaded.
> [!NOTE]
> On Windows, symbolic links must be activated for `hatch run dev` to work. On Windows 10
> or above for Python version 3.8 or higher, this can be done by
> [activating developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).
>
> Alternatively, you can run `hatch run build` to rebuild and reinstall the extension each
> time the source code changes, and `hatch run jupyter lab` to start a new JupyterLab
> server.
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-datalogs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/69/30/792b4ad4e8d7a29d5aa1843f141063e91ab61884d5d553f3fc272e84ebab/jupyterlab_datalogs-0.6.0.tar.gz",
"platform": null,
"description": "# JupyterLab DataLogs\n\n[](https://pypi.org/project/jupyterlab-datalogs/)\n[](https://pypi.org/project/jupyterlab-datalogs/)\n[](https://github.com/PainterQubits/jupyterlab-datalogs/blob/main/LICENSE)\n[](https://github.com/PainterQubits/jupyterlab-datalogs/actions/workflows/ci.yml)\n\nJupyterLab extension for DataLogs.\n\n## Installation\n\nInstall the latest version of JupyterLab DataLogs using pip:\n\n```\npip install -U jupyterlab-datalogs\n```\n\nThis extension should run alongside\n[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)\nversion 4 (included with the `jupyterlab` extra). There are also a set of packages\nrequired for analysis using DataLogs notebooks (included with the `analysis` extra), and\na set of recommended JupyterLab plugins (included with the `plugins` extra).\n\nTo automatically install with all of these extras, use the `all` extra:\n\n```\npip install -U \"jupyterlab-datalogs[all]\"\n```\n\nWhile the Real-Time Collaboration extension is included in the `plugins` extra for\n[JupyterLab Open Warning](https://github.com/PainterQubits/jupyterlab-open-warning) to\nwork, the collaboration functionality can be disabled by running JupyterLab with the\nfollowing option:\n\n```\njupyter lab --YDocExtension.disable_rtc True\n```\n\n## Development\n\nTo develop, the following dependencies must be installed:\n\n- [Node.js](https://nodejs.org/en/download)\n- [Yarn](https://yarnpkg.com/getting-started/install)\n- [Python](https://www.python.org/downloads/)\n- [Hatch](https://hatch.pypa.io/latest/install/)\n\nThen, run\n\n```bash\nhatch run ci:jlpm\n```\n\nto install Node.js dependencies, and\n\n```bash\nhatch run dev\n```\n\nto build the extension and start up a JupyterLab server. The first time you do this, also\ngo to the Extension Manager tab in JupyterLab (the puzzle piece icon on the left) to\nenable 3rd party extensions. Now the extension should be activated. When the source code\nchanges, it should automatically rebuild, and the updated extension will be used when the\npage is reloaded.\n\n> [!NOTE] \n> On Windows, symbolic links must be activated for `hatch run dev` to work. On Windows 10\n> or above for Python version 3.8 or higher, this can be done by\n> [activating developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).\n>\n> Alternatively, you can run `hatch run build` to rebuild and reinstall the extension each\n> time the source code changes, and `hatch run jupyter lab` to start a new JupyterLab\n> server.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023\u20132024, California Institute of Technology 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 extension for DataLogs.",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/PainterQubits/jupyterlab-datalogs",
"Repository": "https://github.com/PainterQubits/jupyterlab-datalogs"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a68f4ebedfbead5f1e3cbbb77978ea021165c8deb409e06399df2c83753e0912",
"md5": "13dfd0621c819ff87a08bfe9db4ffcbc",
"sha256": "b7a2f877c38007a36cde03abc2ca60182b71cb67786fa169fa4aa2e1761e4f02"
},
"downloads": -1,
"filename": "jupyterlab_datalogs-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "13dfd0621c819ff87a08bfe9db4ffcbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18681,
"upload_time": "2024-08-29T20:36:14",
"upload_time_iso_8601": "2024-08-29T20:36:14.953018Z",
"url": "https://files.pythonhosted.org/packages/a6/8f/4ebedfbead5f1e3cbbb77978ea021165c8deb409e06399df2c83753e0912/jupyterlab_datalogs-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6930792b4ad4e8d7a29d5aa1843f141063e91ab61884d5d553f3fc272e84ebab",
"md5": "5c06fe7d67430903d6843186e66557d5",
"sha256": "fef7c5472a5976aff2260577f6546cb5638488066fc4e80c70f4b55fe08292d1"
},
"downloads": -1,
"filename": "jupyterlab_datalogs-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "5c06fe7d67430903d6843186e66557d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 89890,
"upload_time": "2024-08-29T20:36:16",
"upload_time_iso_8601": "2024-08-29T20:36:16.271107Z",
"url": "https://files.pythonhosted.org/packages/69/30/792b4ad4e8d7a29d5aa1843f141063e91ab61884d5d553f3fc272e84ebab/jupyterlab_datalogs-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 20:36:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PainterQubits",
"github_project": "jupyterlab-datalogs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-datalogs"
}
