| Name | jupyterhub-comments JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension that allows adding comments to notebooks and documents in a multiuser environment. |
| upload_time | 2024-10-27 14:07:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Vadim Arnold 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 |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterhub_comments
A JupyterLab extension that allows adding comments to notebooks and documents in a multiuser environment, where files are shared between users, wher the main goal is the review process
# Features
* Add comments to specific cells of jupyter notebooks or lines of text documents
* Edit, delete, resolve and reply to comments
* Icons indicate when comments are added to a document and highlight the comment upon clicking
* Clicking a comment text in an interface focuses notebook cell / line where comment was placed
[Examples and more detailed documentation](https://github.com/SausageLion/jupyterhub-comments/blob/main/docs/README.md)
## Requirements
- JupyterLab >= 4.0.0,<5
## Install
To install the extension, execute:
```bash
pip install jupyterhub_comments
```
To enable comment sharing among users, set the JUPYTERHUB_COMMENTS_DB_PATH environment variable to specify the directory where the comments.db file should be stored. By default, the comments are saved in the directory where the extension is installed, which may vary between users or be non-writable if the extension is installed globally, thus preventing comment sharing.
Ensure that Jupyter users have read, write, and execute permissions for the directory where the comments.db file is located, and read and write permissions for the file itself.
The library will attempt to configure these permissions automatically by creating the specified directory from JUPYTERHUB_COMMENTS_DB_PATH with 775 permissions for the current user and the jupyterhub-users group, and setting 664 permissions on the comments.db file. You can change the default jupyterhub-users group by using the JUPYTERHUB_COMMENTS_DB_GROUP environment variable.
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterhub_comments
```
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterhub-comments",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Vadim Arnold <vadim.arnold@bk.ru>",
"download_url": "https://files.pythonhosted.org/packages/4f/29/1382746bc9ea9a41305d4b3b3a5ff3db0cd2f38a6b104fbd02665fb21c6a/jupyterhub_comments-1.0.1.tar.gz",
"platform": null,
"description": "# jupyterhub_comments\n\nA JupyterLab extension that allows adding comments to notebooks and documents in a multiuser environment, where files are shared between users, wher the main goal is the review process\n\n\n\n# Features\n\n* Add comments to specific cells of jupyter notebooks or lines of text documents\n* Edit, delete, resolve and reply to comments\n* Icons indicate when comments are added to a document and highlight the comment upon clicking\n* Clicking a comment text in an interface focuses notebook cell / line where comment was placed\n\n[Examples and more detailed documentation](https://github.com/SausageLion/jupyterhub-comments/blob/main/docs/README.md)\n\n## Requirements\n\n- JupyterLab >= 4.0.0,<5\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterhub_comments\n```\n\nTo enable comment sharing among users, set the JUPYTERHUB_COMMENTS_DB_PATH environment variable to specify the directory where the comments.db file should be stored. By default, the comments are saved in the directory where the extension is installed, which may vary between users or be non-writable if the extension is installed globally, thus preventing comment sharing.\n\nEnsure that Jupyter users have read, write, and execute permissions for the directory where the comments.db file is located, and read and write permissions for the file itself.\n\nThe library will attempt to configure these permissions automatically by creating the specified directory from JUPYTERHUB_COMMENTS_DB_PATH with 775 permissions for the current user and the jupyterhub-users group, and setting 664 permissions on the comments.db file. You can change the default jupyterhub-users group by using the JUPYTERHUB_COMMENTS_DB_GROUP environment variable.\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterhub_comments\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Vadim Arnold 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 JupyterLab extension that allows adding comments to notebooks and documents in a multiuser environment.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/SausageLion/jupyterhub-comments/issues",
"Homepage": "https://github.com/SausageLion/jupyterhub-comments",
"Repository": "https://github.com/SausageLion/jupyterhub-comments.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3dd3e4b2a56758788e262d8659e6d91c46c41f9bde7e128a29e7c80f34969447",
"md5": "bb6519b927b413cd157947063cbabe45",
"sha256": "fbb25cc9fd3f09e890a66df455d60cd4df5cca3b25d33ed0fc65f49df297f35f"
},
"downloads": -1,
"filename": "jupyterhub_comments-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb6519b927b413cd157947063cbabe45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 41266,
"upload_time": "2024-10-27T14:06:51",
"upload_time_iso_8601": "2024-10-27T14:06:51.111820Z",
"url": "https://files.pythonhosted.org/packages/3d/d3/e4b2a56758788e262d8659e6d91c46c41f9bde7e128a29e7c80f34969447/jupyterhub_comments-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f291382746bc9ea9a41305d4b3b3a5ff3db0cd2f38a6b104fbd02665fb21c6a",
"md5": "4f7eeb65c4cba3accd710263749fed8f",
"sha256": "811afd7aec7ca8f5a54601195f4e286ad3266460f3c7ce8d463037c771ac2044"
},
"downloads": -1,
"filename": "jupyterhub_comments-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4f7eeb65c4cba3accd710263749fed8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12673164,
"upload_time": "2024-10-27T14:07:03",
"upload_time_iso_8601": "2024-10-27T14:07:03.861598Z",
"url": "https://files.pythonhosted.org/packages/4f/29/1382746bc9ea9a41305d4b3b3a5ff3db0cd2f38a6b104fbd02665fb21c6a/jupyterhub_comments-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 14:07:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SausageLion",
"github_project": "jupyterhub-comments",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyterhub-comments"
}
