# pythreejs
[![Interactive demo on Binder][binder-badge]][binder]
[![Install from PyPI][pypi-badge]][pypi]
[![Install from conda-forge][cf-badge]][cf]
[![Reuse from npm][npm-badge]][npm]
[![Documentation Status][docs-badge]][docs]
[![Build Status][ci-badge]][ci]
A Python / ThreeJS bridge for [Jupyter Widgets][widgets].
![Screencast]
[binder-badge]: https://mybinder.org/badge_logo.svg
[binder]: https://mybinder.org/v2/gh/jupyter-widgets/pythreejs/HEAD?urlpath=lab%2Ftree%2Fexamples%2FExamples.ipynb
[pypi-badge]: https://img.shields.io/pypi/v/pythreejs?logo=pypi
[pypi]: https://pypi.org/project/pythreejs
[cf-badge]: https://img.shields.io/conda/vn/conda-forge/pythreejs?logo=conda-forge
[cf]: https://anaconda.org/conda-forge/pythreejs
[npm-badge]: https://img.shields.io/npm/v/jupyter-threejs?logo=npm
[npm]: https://www.npmjs.com/package/jupyter-threejs
[docs-badge]: https://readthedocs.org/projects/pythreejs/badge/?version=stable
[docs]: https://pythreejs.readthedocs.io/en/stable
[ci-badge]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml/badge.svg
[ci]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml?query=branch%3Amaster
[widgets]: https://jupyter.org/widgets
[screencast]: https://raw.githubusercontent.com/jupyter-widgets/pythreejs/master/screencast.gif
## Installation
Using `pip`:
```bash
pip install pythreejs
```
or `conda`:
```bash
conda install -c conda-forge pythreejs
```
> For a development install, see the [contributing guide][contributing].
The extension should then be installed automatically for your Jupyter client.
> For JupyterLab `<3`, you may also need to ensure `nodejs` is installed, and
> rebuild the application:
>
> ```bash
> # conda install -c cond-forge 'nodejs>=12'
> jupyter lab build
> ```
[contributing]: https://github.com/jupyter-widgets/pythreejs/blob/master/CONTRIBUTING.md
## Troubleshooting
If the extension is not automatically installed, you can manually enable it
### Jupyter Notebook Classic
```bash
jupyter nbextension list
jupyter nbextension install --py --symlink --sys-prefix pythreejs
jupyter nbextension enable --py --sys-prefix pythreejs
jupyter nbextension list
```
You should see:
```bash
Known nbextensions:
...
jupyter-js-widgets/extension enabled
- Validating: OK
```
> Note for developers: the `--symlink` argument on Linux or MacOS allows one to
> modify the JavaScript code in-place. This feature is not available on Windows.
### JupyterLab
To perform a _source installation_:
```bash
## ensure you have nodejs install, e.g. with conda
# conda install -c conda-forge 'nodejs>=12'
jupyter labextension list
jupyter labextension install --no-build @jupyter-widgets/jupyterlab-manager
jupyter labextension install --no-build jupyter-datawidgets/extension
jupyter labextension install jupyter-threejs
jupyter labextension list
```
You should see:
```bash
JupyterLab v...
...
jupyterlab-datawidgets v... enabled OK
@jupyter-widgets/jupyterlab-manager v... enabled OK
jupyter-threejs v... enabled OK
```
> This approach is _not recommended_ for JupyterLab 3, which enables
> _federated modules_, installed via `pip`, `conda` or other package managers,
> and does not require rebuilding the entire application.
## Uninstallation
Using `pip`:
```bash
pip uninstall pythreejs
```
or `conda`:
```bash
conda uninstall pythreejs
```
> If you applied any manual steps above, it may be necessary to remove the
### Jupyter Notebook Classic
```bash
jupyter nbextension disable --py --sys-prefix pythreejs
```
### Jupyter Lab
```bash
jupyter labextension uninstall jupyter-threejs
```
## Open Source
This software is licensed under the [BSD-3-Clause][] License.
[bsd-3-clause]: https://github.com/jupyter-widgets/pythreejs/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/jupyter-widgets/pythreejs",
"name": "pythreejs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "ipython,jupyter,widgets,webgl,graphics,3d",
"author": "PyThreejs Development Team",
"author_email": "jason@jasongrout.org",
"download_url": "https://files.pythonhosted.org/packages/0a/2e/0ec94286b8eb3fe1200700080e8adb2c8d871bb8db589858a49600d97a7d/pythreejs-2.4.2.tar.gz",
"platform": null,
"description": "# pythreejs\n\n[![Interactive demo on Binder][binder-badge]][binder]\n[![Install from PyPI][pypi-badge]][pypi]\n[![Install from conda-forge][cf-badge]][cf]\n[![Reuse from npm][npm-badge]][npm]\n[![Documentation Status][docs-badge]][docs]\n[![Build Status][ci-badge]][ci]\n\nA Python / ThreeJS bridge for [Jupyter Widgets][widgets].\n\n![Screencast]\n\n[binder-badge]: https://mybinder.org/badge_logo.svg\n[binder]: https://mybinder.org/v2/gh/jupyter-widgets/pythreejs/HEAD?urlpath=lab%2Ftree%2Fexamples%2FExamples.ipynb\n[pypi-badge]: https://img.shields.io/pypi/v/pythreejs?logo=pypi\n[pypi]: https://pypi.org/project/pythreejs\n[cf-badge]: https://img.shields.io/conda/vn/conda-forge/pythreejs?logo=conda-forge\n[cf]: https://anaconda.org/conda-forge/pythreejs\n[npm-badge]: https://img.shields.io/npm/v/jupyter-threejs?logo=npm\n[npm]: https://www.npmjs.com/package/jupyter-threejs\n[docs-badge]: https://readthedocs.org/projects/pythreejs/badge/?version=stable\n[docs]: https://pythreejs.readthedocs.io/en/stable\n[ci-badge]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml/badge.svg\n[ci]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml?query=branch%3Amaster\n[widgets]: https://jupyter.org/widgets\n[screencast]: https://raw.githubusercontent.com/jupyter-widgets/pythreejs/master/screencast.gif\n\n## Installation\n\nUsing `pip`:\n\n```bash\npip install pythreejs\n```\n\nor `conda`:\n\n```bash\nconda install -c conda-forge pythreejs\n```\n\n> For a development install, see the [contributing guide][contributing].\n\nThe extension should then be installed automatically for your Jupyter client.\n\n> For JupyterLab `<3`, you may also need to ensure `nodejs` is installed, and\n> rebuild the application:\n>\n> ```bash\n> # conda install -c cond-forge 'nodejs>=12'\n> jupyter lab build\n> ```\n\n[contributing]: https://github.com/jupyter-widgets/pythreejs/blob/master/CONTRIBUTING.md\n\n## Troubleshooting\n\nIf the extension is not automatically installed, you can manually enable it\n\n### Jupyter Notebook Classic\n\n```bash\njupyter nbextension list\njupyter nbextension install --py --symlink --sys-prefix pythreejs\njupyter nbextension enable --py --sys-prefix pythreejs\njupyter nbextension list\n```\n\nYou should see:\n\n```bash\nKnown nbextensions:\n ...\n jupyter-js-widgets/extension enabled\n - Validating: OK\n```\n\n> Note for developers: the `--symlink` argument on Linux or MacOS allows one to\n> modify the JavaScript code in-place. This feature is not available on Windows.\n\n### JupyterLab\n\nTo perform a _source installation_:\n\n```bash\n## ensure you have nodejs install, e.g. with conda\n# conda install -c conda-forge 'nodejs>=12'\njupyter labextension list\njupyter labextension install --no-build @jupyter-widgets/jupyterlab-manager\njupyter labextension install --no-build jupyter-datawidgets/extension\njupyter labextension install jupyter-threejs\njupyter labextension list\n```\n\nYou should see:\n\n```bash\nJupyterLab v...\n ...\n jupyterlab-datawidgets v... enabled OK\n @jupyter-widgets/jupyterlab-manager v... enabled OK\n jupyter-threejs v... enabled OK\n\n```\n\n> This approach is _not recommended_ for JupyterLab 3, which enables\n> _federated modules_, installed via `pip`, `conda` or other package managers,\n> and does not require rebuilding the entire application.\n\n## Uninstallation\n\nUsing `pip`:\n\n```bash\npip uninstall pythreejs\n```\n\nor `conda`:\n\n```bash\nconda uninstall pythreejs\n```\n\n> If you applied any manual steps above, it may be necessary to remove the\n\n### Jupyter Notebook Classic\n\n```bash\njupyter nbextension disable --py --sys-prefix pythreejs\n```\n\n### Jupyter Lab\n\n```bash\njupyter labextension uninstall jupyter-threejs\n```\n\n## Open Source\n\nThis software is licensed under the [BSD-3-Clause][] License.\n\n[bsd-3-clause]: https://github.com/jupyter-widgets/pythreejs/blob/master/LICENSE\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Interactive 3D graphics for the Jupyter Notebook and JupyterLab, using Three.js and Jupyter Widgets.",
"version": "2.4.2",
"split_keywords": [
"ipython",
"jupyter",
"widgets",
"webgl",
"graphics",
"3d"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d88be2bbeb42068f0c48899e8eddd34902afc0f7429d4d2a152d2dc2670dc661",
"md5": "cb04d63cce48967f859aa415a3830440",
"sha256": "8418807163ad91f4df53b58c4e991b26214852a1236f28f1afeaadf99d095818"
},
"downloads": -1,
"filename": "pythreejs-2.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb04d63cce48967f859aa415a3830440",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3363905,
"upload_time": "2023-02-20T00:23:27",
"upload_time_iso_8601": "2023-02-20T00:23:27.283632Z",
"url": "https://files.pythonhosted.org/packages/d8/8b/e2bbeb42068f0c48899e8eddd34902afc0f7429d4d2a152d2dc2670dc661/pythreejs-2.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a2e0ec94286b8eb3fe1200700080e8adb2c8d871bb8db589858a49600d97a7d",
"md5": "b4064be2f60ee1bb09fcce763fdf3bb0",
"sha256": "a568bfdc4c3797c4c2339158928edc7dcf6fa4a267b08e3cec5121e2078b5bd6"
},
"downloads": -1,
"filename": "pythreejs-2.4.2.tar.gz",
"has_sig": false,
"md5_digest": "b4064be2f60ee1bb09fcce763fdf3bb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4731310,
"upload_time": "2023-02-20T00:23:30",
"upload_time_iso_8601": "2023-02-20T00:23:30.081072Z",
"url": "https://files.pythonhosted.org/packages/0a/2e/0ec94286b8eb3fe1200700080e8adb2c8d871bb8db589858a49600d97a7d/pythreejs-2.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-20 00:23:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jupyter-widgets",
"github_project": "pythreejs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pythreejs"
}
JSON
