# Jupyter Lab and Notebook Extensions for Fugue
The extensions enables the magic `%%fsql` and Fugue SQL highlights. It also enables pretty print of dataframes.
## Install
To install the extension, execute:
```bash
pip install fugue-jupyter
```
### Enable highlights on classic notebooks
To enable syntax highlights on classic notebooks, you will need to firstly install [jupyter-contrib-nbextensions](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/install.html) (this is NOT automatically done by installing fugue-jupyter), and then run:
```bash
fugue-jupyter install nbextension
```
Or if you want to manually install with special parameters, you can just let it show the command to be executed, you can modify them and run manually:
```bash
fugue-jupyter install nbextension --show
```
### Register startup script
For both lab and classic notebooks, you must register a startup script so the system can understand `%%fsql` means running the cell as Fugue SQL, this is separated from highlighting:
```bash
fugue-jupyter install startup
```
Or if you want to add the startup script to a specific profile (for example abc):
```bash
fugue-jupyter install startup abc
```
## Uninstall
To remove the extension, execute:
```bash
fugue-jupyter uninstall startup
pip uninstall fugue-jupyter
```
Raw data
{
"_id": null,
"home_page": "https://github.com/fugue-project/fugue-jupyter",
"name": "fugue-jupyter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "The Fugue Development Team",
"author_email": "hello@fugue.ai",
"download_url": "https://files.pythonhosted.org/packages/72/5a/b68726011da895c7bb98a6b227f1b3620af1e549bdceae09e55e2c44eb1c/fugue_jupyter-0.2.3.tar.gz",
"platform": "Linux",
"description": "# Jupyter Lab and Notebook Extensions for Fugue\n\nThe extensions enables the magic `%%fsql` and Fugue SQL highlights. It also enables pretty print of dataframes.\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install fugue-jupyter\n```\n\n### Enable highlights on classic notebooks\n\nTo enable syntax highlights on classic notebooks, you will need to firstly install [jupyter-contrib-nbextensions](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/install.html) (this is NOT automatically done by installing fugue-jupyter), and then run:\n\n```bash\nfugue-jupyter install nbextension\n```\n\nOr if you want to manually install with special parameters, you can just let it show the command to be executed, you can modify them and run manually:\n\n```bash\nfugue-jupyter install nbextension --show\n```\n\n### Register startup script\n\nFor both lab and classic notebooks, you must register a startup script so the system can understand `%%fsql` means running the cell as Fugue SQL, this is separated from highlighting:\n\n```bash\nfugue-jupyter install startup\n```\n\nOr if you want to add the startup script to a specific profile (for example abc):\n\n```bash\nfugue-jupyter install startup abc\n```\n\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\nfugue-jupyter uninstall startup\npip uninstall fugue-jupyter\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Jupyterlab Extension for Fugue",
"version": "0.2.3",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "70efdb087a84dd4b08b8fe6d0b2da4f32fb5d8286f1768369eb50da087874197",
"md5": "7ea33f9b452415ee2d57925ef3709cbb",
"sha256": "b163ac09964063a4c68a25af3fadccfb80459c64567e3d3cf443523cac7103bc"
},
"downloads": -1,
"filename": "fugue_jupyter-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ea33f9b452415ee2d57925ef3709cbb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 95146,
"upload_time": "2023-04-07T06:04:04",
"upload_time_iso_8601": "2023-04-07T06:04:04.988966Z",
"url": "https://files.pythonhosted.org/packages/70/ef/db087a84dd4b08b8fe6d0b2da4f32fb5d8286f1768369eb50da087874197/fugue_jupyter-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "725ab68726011da895c7bb98a6b227f1b3620af1e549bdceae09e55e2c44eb1c",
"md5": "3cd25326eccd543e6731c2912b00fe9b",
"sha256": "be28511b1f38536375fa5110329d1ff6bfdea35c57bddf9ef7443f16ace9c629"
},
"downloads": -1,
"filename": "fugue_jupyter-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "3cd25326eccd543e6731c2912b00fe9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 195471,
"upload_time": "2023-04-07T06:04:07",
"upload_time_iso_8601": "2023-04-07T06:04:07.120567Z",
"url": "https://files.pythonhosted.org/packages/72/5a/b68726011da895c7bb98a6b227f1b3620af1e549bdceae09e55e2c44eb1c/fugue_jupyter-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 06:04:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fugue-project",
"github_project": "fugue-jupyter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fugue-jupyter"
}