# jupyterlab-collaborative-input
Display collaborative inputs in JupyterLab
## Requirements
- JupyterLab >= 4.0
## Install
To install this package with [`pip`](https://pip.pypa.io/en/stable/) run
```bash
pip install jupyterlab_collaborative_input
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab_collaborative_input directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
```
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 extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
#### Publishing
Before starting, you'll need to have run: `pip install twine jupyter_packaging`
1. Update the version in `package.json` and update the release date in `CHANGELOG.md`
2. Commit the change in step 1, tag it, then push it
```
git commit -am <msg>
git tag vX.Z.Y
git push && git push --tags
```
3. Create the artifacts
```
rm -rf dist build jupyterlab_collaborative_input/labextension
jlpm run build
python setup.py sdist bdist_wheel
```
4. Test this against the test pypi. You can then install from here to test as well:
```
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_collaborative_input
```
5. Upload this to pypi:
```
twine upload dist/*
```
### Uninstall
```bash
pip uninstall jupyterlab_collaborative_input
```
Raw data
{
"_id": null,
"home_page": "https://github.com/davidbrochart/jupyterlab-collaborative-input",
"name": "jupyterlab-collaborative-input",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Jupyter, JupyterLab, JupyterLab4",
"author": "David Brochart",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b9/10/9aa7a58b3ac761f161c9a3fe8c4a170991f374216b2f0ce0530bd22e24b0/jupyterlab_collaborative_input-0.1.0.tar.gz",
"platform": "Linux",
"description": "# jupyterlab-collaborative-input\n\nDisplay collaborative inputs in JupyterLab\n\n## Requirements\n\n- JupyterLab >= 4.0\n\n## Install\n\nTo install this package with [`pip`](https://pip.pypa.io/en/stable/) run\n\n```bash\npip install jupyterlab_collaborative_input\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyterlab_collaborative_input directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou 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 extension.\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\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n#### Publishing\n\nBefore starting, you'll need to have run: `pip install twine jupyter_packaging`\n\n1. Update the version in `package.json` and update the release date in `CHANGELOG.md`\n2. Commit the change in step 1, tag it, then push it\n\n```\ngit commit -am <msg>\ngit tag vX.Z.Y\ngit push && git push --tags\n```\n\n3. Create the artifacts\n\n```\nrm -rf dist build jupyterlab_collaborative_input/labextension\njlpm run build\npython setup.py sdist bdist_wheel\n```\n\n4. Test this against the test pypi. You can then install from here to test as well:\n\n```\ntwine upload --repository-url https://test.pypi.org/legacy/ dist/*\n# In a new venv\npip install --index-url https://test.pypi.org/simple/ jupyterlab_collaborative_input\n```\n\n5. Upload this to pypi:\n\n```\ntwine upload dist/*\n```\n\n### Uninstall\n\n```bash\npip uninstall jupyterlab_collaborative_input\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Display collaborative inputs in JupyterLab",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/davidbrochart/jupyterlab-collaborative-input"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab4"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aabc34f98197bac0839fcd82491733d9c20511f30b3acad95f9643d53134b9d3",
"md5": "1721c0710e2bd25a44d5a352444e6cdf",
"sha256": "89491ed65cb415bbf20b2087a842916f7e48e00819125a56851e2f233c045f07"
},
"downloads": -1,
"filename": "jupyterlab_collaborative_input-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1721c0710e2bd25a44d5a352444e6cdf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 52040,
"upload_time": "2024-06-04T14:55:19",
"upload_time_iso_8601": "2024-06-04T14:55:19.885461Z",
"url": "https://files.pythonhosted.org/packages/aa/bc/34f98197bac0839fcd82491733d9c20511f30b3acad95f9643d53134b9d3/jupyterlab_collaborative_input-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9109aa7a58b3ac761f161c9a3fe8c4a170991f374216b2f0ce0530bd22e24b0",
"md5": "5d62f446a060031deee83794a1dff6ff",
"sha256": "fc54a2b4b7a3f1456c4843a729c520132e65b12c7f4e9e3cf9f829f789aaef41"
},
"downloads": -1,
"filename": "jupyterlab_collaborative_input-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5d62f446a060031deee83794a1dff6ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22772,
"upload_time": "2024-06-04T14:55:21",
"upload_time_iso_8601": "2024-06-04T14:55:21.371549Z",
"url": "https://files.pythonhosted.org/packages/b9/10/9aa7a58b3ac761f161c9a3fe8c4a170991f374216b2f0ce0530bd22e24b0/jupyterlab_collaborative_input-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 14:55:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davidbrochart",
"github_project": "jupyterlab-collaborative-input",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jupyterlab-collaborative-input"
}
JSON
