| Name | guidance-stitch JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Bidirectional comms for Jupyter and JavaScript. |
| upload_time | 2024-12-19 06:14:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright (c) 2024 Guidance Contributors 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
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# stitch
[](https://travis-ci.org/guidance-ai/stitch)
[](https://codecov.io/gh/guidance-ai/stitch)
Bidirectional comms for Jupyter and JavaScript.
## Installation
You can install using `pip`:
```bash
pip install stitch
```
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:
```bash
jupyter nbextension enable --py [--sys-prefix|--user|--system] stitch
```
## Development Installation
Create a dev environment:
```bash
conda create -n stitch-dev -c conda-forge nodejs python jupyterlab=4.0.11
conda activate stitch-dev
```
Install the python. This will also build the TS package.
```bash
pip install -e ".[test, examples]"
```
When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:
```
jupyter labextension develop --overwrite .
jlpm run build
```
For classic notebook, you need to run:
```
jupyter nbextension install --sys-prefix --symlink --overwrite --py stitch
jupyter nbextension enable --sys-prefix --py stitch
```
Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
the `install` command every time that you rebuild your extension. For certain installations
you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
of those flags here.
### How to see your changes
#### Typescript:
If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
terminals to watch for changes in the extension's source and automatically rebuild the widget.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
#### Python:
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
## Updating the version
To update the version, install tbump and use it to bump the version.
By default it will also create a tag.
```bash
pip install tbump
tbump <new-version>
```
Raw data
{
"_id": null,
"home_page": null,
"name": "guidance-stitch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "IPython, Jupyter, Widgets",
"author": null,
"author_email": "Guidance Maintainers <maintainers@guidance-ai.org>",
"download_url": "https://files.pythonhosted.org/packages/ad/e6/82cdd955e32c17498d10cbc4bd35d2066b7cfc8236e9e84d609f354f93be/guidance_stitch-0.1.0.tar.gz",
"platform": null,
"description": "\n# stitch\n\n[](https://travis-ci.org/guidance-ai/stitch)\n[](https://codecov.io/gh/guidance-ai/stitch)\n\n\nBidirectional comms for Jupyter and JavaScript.\n\n## Installation\n\nYou can install using `pip`:\n\n```bash\npip install stitch\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] stitch\n```\n\n## Development Installation\n\nCreate a dev environment:\n```bash\nconda create -n stitch-dev -c conda-forge nodejs python jupyterlab=4.0.11\nconda activate stitch-dev\n```\n\nInstall the python. This will also build the TS package.\n```bash\npip install -e \".[test, examples]\"\n```\n\nWhen developing your extensions, you need to manually enable your extensions with the\nnotebook / lab frontend. For lab, this is done by the command:\n\n```\njupyter labextension develop --overwrite .\njlpm run build\n```\n\nFor classic notebook, you need to run:\n\n```\njupyter nbextension install --sys-prefix --symlink --overwrite --py stitch\njupyter nbextension enable --sys-prefix --py stitch\n```\n\nNote that the `--symlink` flag doesn't work on Windows, so you will here have to run\nthe `install` command every time that you rebuild your extension. For certain installations\nyou might also need another flag instead of `--sys-prefix`, but we won't cover the meaning\nof those flags here.\n\n### How to see your changes\n#### Typescript:\nIf you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different\nterminals to watch for changes in the extension's source and automatically rebuild the widget.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.\n\n#### Python:\nIf you make a change to the python code then you will need to restart the notebook kernel to have it take effect.\n\n## Updating the version\n\nTo update the version, install tbump and use it to bump the version.\nBy default it will also create a tag.\n\n```bash\npip install tbump\ntbump <new-version>\n```\n\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 Guidance Contributors 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": "Bidirectional comms for Jupyter and JavaScript.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/guidance-ai/guidance"
},
"split_keywords": [
"ipython",
" jupyter",
" widgets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e99ceeb3e88aca92b61402b43609fff20f9371525c8d121ea67b12f05755d48",
"md5": "315eebe3fef8e519386292a4bc41acbb",
"sha256": "98866b70676836abc75b1c837cb75e58e071d708d9df2a0d78b7da2d7d358c7a"
},
"downloads": -1,
"filename": "guidance_stitch-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "315eebe3fef8e519386292a4bc41acbb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 66131,
"upload_time": "2024-12-19T06:14:50",
"upload_time_iso_8601": "2024-12-19T06:14:50.160747Z",
"url": "https://files.pythonhosted.org/packages/9e/99/ceeb3e88aca92b61402b43609fff20f9371525c8d121ea67b12f05755d48/guidance_stitch-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ade682cdd955e32c17498d10cbc4bd35d2066b7cfc8236e9e84d609f354f93be",
"md5": "42af66da85406c8c48926f00ca3413dd",
"sha256": "00bbc485f486ba1bae422c5ccaee8d9ef19a853247f24adfc715d77f0fb1e003"
},
"downloads": -1,
"filename": "guidance_stitch-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "42af66da85406c8c48926f00ca3413dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 139517,
"upload_time": "2024-12-19T06:14:51",
"upload_time_iso_8601": "2024-12-19T06:14:51.542117Z",
"url": "https://files.pythonhosted.org/packages/ad/e6/82cdd955e32c17498d10cbc4bd35d2066b7cfc8236e9e84d609f354f93be/guidance_stitch-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 06:14:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "guidance-ai",
"github_project": "guidance",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "guidance-stitch"
}
