| Name | jupyterlab-scicap-verdant JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | An adaptation of the Verdant library for logging jupyter lab events in Science Capsule. |
| upload_time | 2023-10-25 15:53:03 |
| maintainer | |
| docs_url | None |
| author | Abdelilah Essiari |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2018 Mary Elizabeth Kery Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyterlab Scicap Verdant
This project is an adaptation of the Verdant project for Science Capsule. Events from Verdant are intercepted and sent to an API so that jupyter events can be stored with other Science Capsule events.
## Verdant
🌱🌿🌱 Verdant is a JupyterLab extension that automatically records history of all experiments you run in a Jupyter notebook, and stores them in a tidy .ipyhistory JSON file designed to be work alongside and compliment any other version control you use, like SVN or Git. Verdant also visualizes history of individual cells, code snippets, markdown, and outputs for you, for quick checks and references as you work.
For design discussion and the research behind this check out the [paper](https://marybethkery.com/projects/Verdant/Towards_effective_foraging_by_data_scientists.pdf):
> Mary Beth Kery, Bonnie E. John, Patrick O’Flaherty, Amber Horvath, and
> Brad A. Myers. 2019. Towards Effective Foraging by Data Scientists to Find
> Past Analysis Choices. In Proceedings of ACM SIGCHI, Glasgow, UK, May
> 2019 (CHI’19), 11 pages. DOI: 10.475/123 4
## Install for Local Development
If developing and making changes to the package locally, run the following commands after making changes:
```bash
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Enable the server extension
jupyter server extension enable jupyterlab_scicap_verdant
# Rebuild extension Typescript source after making changes
jlpm run build
```
Check that the extension is installed and enabled:
```bash
jupyter labextension list
```
Run jupyterlab:
```bash
jupyter lab
```
## Build and Publish
First rebuild the labextension and commit changes.
```
jlpm run build
pip install -e .
git commit add .
git commit -m "My updates"
```
Then upgrade the package version using npm.
```
npm version patch
```
Then build the python distribution.
```
jlpm run build:dist
```
Then publish the `.whl` file to pypi.
```
jlpm run publish
```
In order to publish, you will have to authenticate with pypi and your account must have permission to administer the [jupyterlab-scicap-verdant package](https://pypi.org/project/jupyterlab-scicap-verdant/) on pypi.
## Acknowledgements
The original Verdant library was authored by Mary Beth Kery. Research has been funded by Bloomberg L.P. and has been conducted at the Bloomberg L.P. and at the [Natural Programming Group](https://www.cs.cmu.edu/~NatProg/) at the [Human-Computer Interaction Institute](https://hcii.cmu.edu/) at Carnegie Mellon University. Thank you to the [JupyterLab project](https://github.com/jupyterlab/jupyterlab) and also to all our awesome study participants for volunteering early design feedback!
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlab-scicap-verdant",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Abdelilah Essiari",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# Jupyterlab Scicap Verdant\n\nThis project is an adaptation of the Verdant project for Science Capsule. Events from Verdant are intercepted and sent to an API so that jupyter events can be stored with other Science Capsule events.\n\n## Verdant\n\n\ud83c\udf31\ud83c\udf3f\ud83c\udf31 Verdant is a JupyterLab extension that automatically records history of all experiments you run in a Jupyter notebook, and stores them in a tidy .ipyhistory JSON file designed to be work alongside and compliment any other version control you use, like SVN or Git. Verdant also visualizes history of individual cells, code snippets, markdown, and outputs for you, for quick checks and references as you work.\n\nFor design discussion and the research behind this check out the [paper](https://marybethkery.com/projects/Verdant/Towards_effective_foraging_by_data_scientists.pdf):\n\n> Mary Beth Kery, Bonnie E. John, Patrick O\u2019Flaherty, Amber Horvath, and\n> Brad A. Myers. 2019. Towards Effective Foraging by Data Scientists to Find\n> Past Analysis Choices. In Proceedings of ACM SIGCHI, Glasgow, UK, May\n> 2019 (CHI\u201919), 11 pages. DOI: 10.475/123 4\n\n## Install for Local Development\n\nIf developing and making changes to the package locally, run the following commands after making changes:\n\n```bash\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Enable the server extension\njupyter server extension enable jupyterlab_scicap_verdant\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nCheck that the extension is installed and enabled:\n\n```bash\njupyter labextension list\n```\n\nRun jupyterlab:\n\n```bash\njupyter lab\n```\n\n## Build and Publish\n\nFirst rebuild the labextension and commit changes.\n\n```\njlpm run build\npip install -e .\ngit commit add .\ngit commit -m \"My updates\"\n```\n\nThen upgrade the package version using npm.\n\n```\nnpm version patch\n```\n\nThen build the python distribution.\n\n```\njlpm run build:dist\n```\n\nThen publish the `.whl` file to pypi.\n\n```\njlpm run publish\n```\n\nIn order to publish, you will have to authenticate with pypi and your account must have permission to administer the [jupyterlab-scicap-verdant package](https://pypi.org/project/jupyterlab-scicap-verdant/) on pypi.\n\n## Acknowledgements\n\nThe original Verdant library was authored by Mary Beth Kery. Research has been funded by Bloomberg L.P. and has been conducted at the Bloomberg L.P. and at the [Natural Programming Group](https://www.cs.cmu.edu/~NatProg/) at the [Human-Computer Interaction Institute](https://hcii.cmu.edu/) at Carnegie Mellon University. Thank you to the [JupyterLab project](https://github.com/jupyterlab/jupyterlab) and also to all our awesome study participants for volunteering early design feedback!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2018 Mary Elizabeth Kery Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "An adaptation of the Verdant library for logging jupyter lab events in Science Capsule.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/abessiari/Verdant",
"Repository": "https://github.com/abessiari/Verdant.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f3beb64492f4d16dc7274825d0f2d6fd92e69d319bf5927b7c10ff16fc4924a",
"md5": "b3d299bac45008bd9394624b68be2d33",
"sha256": "c19a2dc551bb5554382ec4bf00b7db646b8c083b7eef710f21a8acfddeba695a"
},
"downloads": -1,
"filename": "jupyterlab_scicap_verdant-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3d299bac45008bd9394624b68be2d33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 430734,
"upload_time": "2023-10-25T15:53:03",
"upload_time_iso_8601": "2023-10-25T15:53:03.138064Z",
"url": "https://files.pythonhosted.org/packages/0f/3b/eb64492f4d16dc7274825d0f2d6fd92e69d319bf5927b7c10ff16fc4924a/jupyterlab_scicap_verdant-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 15:53:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abessiari",
"github_project": "Verdant",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyterlab-scicap-verdant"
}
