# Amazon Q Developer for JupyterLab
Amazon Q Developer is an AI coding companion which provides developers with real-time code suggestions in JupyterLab. Individual developers can use Q Developer for free in JupyterLab and AWS SageMaker Studio.
## Requirements
In order to use Q Developer in JupyterLab, you must have a version of JupyterLab >= 4 installed. You will also need a free [AWS Builder ID](https://docs.aws.amazon.com/signin/latest/userguide/sign-in-aws_builder_id.html) account to access Q Developer. (You can set that up the first time you log in.)
In order to use Q Developer in SageMaker Studio, you must have set up a SageMaker Studio notebook instance, along with an execution role with the appropriate IAM Permissions.
## Getting Started
Install [JupyterLab](https://pypi.org/project/jupyterlab) on your computer or if you already have JupyterLab installed, check it’s version by running the following command.
```
pip show jupyterlab
```
Note the version in the response, and follow the use the corresponding directions in one of the following sections.
### Installation Using Pip for Jupyter Lab version >= 4.0
You can install and enable the Q Developer extension for JupyterLab 4 with the following commands.
```
# JupyterLab 4
pip install amazon-q-developer-jupyterlab-ext
```
Once installed, choose ****Get Started**** from the Amazon Q panel at the bottom of the window. This will enable to you log in to [AWS Builder ID](https://docs.aws.amazon.com/signin/latest/userguide/sign-in-aws_builder_id.html) to access Amazon Q Developer. Refer to [Setting up Q Developer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html) for detailed setup instructions.
### SageMaker Studio
To setup the Q Developer extension with a SageMaker Studio notebook instance, you must add IAM Permissions for
`codewhisperer:GenerateRecommendations` for your user profile. Then you must install and enable the extension with the following commands.
```
conda activate studio
pip install amazon-q-developer-jupyterlab-ext~=1.0
jupyter server extension enable amazon_q_developer_jupyterlab_ext
conda deactivate
restart-jupyter-server
```
After you complete installation and refresh your browser, an Amazon Q panel will appear at the bottom of the window. Refer to [Setting up Q Developer with SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html) for detailed setup instructions.
## Features
### Code Completion
Q Developer for JupyterLab provides AI powered suggestions as ghost text with the following default keybindings. These can be modified in the settings.
| Action | Key Binding |
| ------------------------------ | ----------- |
| Manually trigger Q Developer | Alt C (Window) / ⌥ C (Mac) |
| Accept a recommendation | Tab |
| Next recommendation | Right arrow |
| Previous recommendation | Left arrow |
| Reject a recommendation | ESC |
Python is the only supported programming language for now. Users can start or pause suggestions by toggling the menu item in the Amazon Q panel that will appear at the bottom of the window.
### Code References
With the reference log, you can view references to code recommendations. You can also update and edit code recommendations suggested by Q Developer.
To view Code References for accepted suggestions, choose **Open Code Reference Log** from the Amazon Q panel at the bottom of the window. Users can also turn off code suggestions with code references in Settings.
## More Resources
* [Amazon Q Developer User Guide](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/what-is.html)
* [Setting up Amazon Q Developer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html)
* [Setting up Q Developer with Amazon SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html)
## Change Log
3.4.5
* Bugfix for Completions not within the active code cell.
3.4.4
* Default to Q enabled with free tier in MD
3.4.3
* Update Logic for Glue Code Completion trigger for code recommendations to account for upgrades made in Connections Logic by hitting GetConnection API for MaxDome
* For legal compliance, the Q telemetry settings copy needed to be updated, along with ensuring that when customers choose to opt out of code references, they aren't shown anywhere. It was determined that they were still shown in python files even when opted out.
3.4.2
* Follow up to update code inserted into code reference log should not render any html
3.4.1
* Updated language in Q IDE settings related to telemetry
3.4.0
* Update code inserted into code reference log should not render any html
3.3.0
* Add user agent to http request
* Update Code Completion Trigger for MaxDomeConnectionMagics
3.2.0
* Add support for Glue code completions in MD environments when using Glue-related kernel.
3.1.0
* Fix ArrowDown, ArrowUp not working in JupyterLab 4.2
* Fix dispatch not triggering re-render in JupyterLab 4.2
* Add support for SSO mode
3.0.0
* Rename legacy [Amazon CodeWhisperer for JupyterLab](https://pypi.org/project/amazon-codewhisperer-jupyterlab-ext/) to [Amazon Q Developer for JupyterLab](https://pypi.org/project/amazon-q-developer-jupyterlab-ext/)
Raw data
{
"_id": null,
"home_page": "https://aws.amazon.com/q/developer",
"name": "amazon-q-developer-jupyterlab-ext",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Jupyter, JupyterLab, JupyterLab4, Amazon CodeWhisperer, CodeWhisperer, Code, Whisperer, Q Developer, Amazon Q Developer",
"author": "Amazon Q Developer",
"author_email": "codewhisperer@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/8a/b3/17337a6af7154133f77e9b096c3dfeaa30de753d7aa1397fb499e01b7eda/amazon-q-developer-jupyterlab-ext-3.4.5.tar.gz",
"platform": "Linux",
"description": "# Amazon Q Developer for JupyterLab\n\nAmazon Q Developer is an AI coding companion which provides developers with real-time code suggestions in JupyterLab. Individual developers can use Q Developer for free in JupyterLab and AWS SageMaker Studio.\n\n\n\n## Requirements\n\nIn order to use Q Developer in JupyterLab, you must have a version of JupyterLab >= 4 installed. You will also need a free [AWS Builder ID](https://docs.aws.amazon.com/signin/latest/userguide/sign-in-aws_builder_id.html) account to access Q Developer. (You can set that up the first time you log in.)\n\nIn order to use Q Developer in SageMaker Studio, you must have set up a SageMaker Studio notebook instance, along with an execution role with the appropriate IAM Permissions. \n\n## Getting Started\n\nInstall [JupyterLab](https://pypi.org/project/jupyterlab) on your computer or if you already have JupyterLab installed, check it\u2019s version by running the following command.\n\n```\npip show jupyterlab\n```\n\nNote the version in the response, and follow the use the corresponding directions in one of the following sections.\n\n### Installation Using Pip for Jupyter Lab version >= 4.0\n\nYou can install and enable the Q Developer extension for JupyterLab 4 with the following commands. \n\n```\n# JupyterLab 4\npip install amazon-q-developer-jupyterlab-ext\n```\n\nOnce installed, choose ****Get Started**** from the Amazon Q panel at the bottom of the window. This will enable to you log in to [AWS Builder ID](https://docs.aws.amazon.com/signin/latest/userguide/sign-in-aws_builder_id.html) to access Amazon Q Developer. Refer to [Setting up Q Developer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html) for detailed setup instructions.\n\n### SageMaker Studio\n\nTo setup the Q Developer extension with a SageMaker Studio notebook instance, you must add IAM Permissions for \n`codewhisperer:GenerateRecommendations` for your user profile. Then you must install and enable the extension with the following commands.\n\n```\nconda activate studio\npip install amazon-q-developer-jupyterlab-ext~=1.0\njupyter server extension enable amazon_q_developer_jupyterlab_ext\nconda deactivate\nrestart-jupyter-server\n```\n\nAfter you complete installation and refresh your browser, an Amazon Q panel will appear at the bottom of the window. Refer to [Setting up Q Developer with SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html) for detailed setup instructions. \n\n## Features\n\n### Code Completion\n\nQ Developer for JupyterLab provides AI powered suggestions as ghost text with the following default keybindings. These can be modified in the settings.\n\n\n| Action\t | Key Binding |\n| ------------------------------ | ----------- |\n| Manually trigger Q Developer | Alt C (Window) / \u2325 C (Mac) |\n| Accept a recommendation | Tab |\n| Next recommendation | Right arrow |\n| Previous recommendation | Left arrow |\n| Reject a recommendation | ESC |\n\n\n\nPython is the only supported programming language for now. Users can start or pause suggestions by toggling the menu item in the Amazon Q panel that will appear at the bottom of the window.\n\n### Code References\n\nWith the reference log, you can view references to code recommendations. You can also update and edit code recommendations suggested by Q Developer.\n\nTo view Code References for accepted suggestions, choose **Open Code Reference Log** from the Amazon Q panel at the bottom of the window. Users can also turn off code suggestions with code references in Settings.\n\n\n## More Resources\n\n* [Amazon Q Developer User Guide](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/what-is.html)\n* [Setting up Amazon Q Developer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html)\n* [Setting up Q Developer with Amazon SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html)\n\n## Change Log\n\n3.4.5\n* Bugfix for Completions not within the active code cell.\n\n3.4.4\n* Default to Q enabled with free tier in MD\n\n3.4.3\n* Update Logic for Glue Code Completion trigger for code recommendations to account for upgrades made in Connections Logic by hitting GetConnection API for MaxDome\n* For legal compliance, the Q telemetry settings copy needed to be updated, along with ensuring that when customers choose to opt out of code references, they aren't shown anywhere. It was determined that they were still shown in python files even when opted out.\n\n3.4.2\n* Follow up to update code inserted into code reference log should not render any html\n\n3.4.1\n* Updated language in Q IDE settings related to telemetry \n\n3.4.0\n* Update code inserted into code reference log should not render any html\n\n3.3.0\n* Add user agent to http request\n* Update Code Completion Trigger for MaxDomeConnectionMagics\n\n3.2.0\n* Add support for Glue code completions in MD environments when using Glue-related kernel.\n\n3.1.0\n* Fix ArrowDown, ArrowUp not working in JupyterLab 4.2\n* Fix dispatch not triggering re-render in JupyterLab 4.2\n* Add support for SSO mode\n\n3.0.0\n* Rename legacy [Amazon CodeWhisperer for JupyterLab](https://pypi.org/project/amazon-codewhisperer-jupyterlab-ext/) to [Amazon Q Developer for JupyterLab](https://pypi.org/project/amazon-q-developer-jupyterlab-ext/)\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Amazon Q Developer for JupyterLab",
"version": "3.4.5",
"project_urls": {
"Homepage": "https://aws.amazon.com/q/developer"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab4",
" amazon codewhisperer",
" codewhisperer",
" code",
" whisperer",
" q developer",
" amazon q developer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ab317337a6af7154133f77e9b096c3dfeaa30de753d7aa1397fb499e01b7eda",
"md5": "b419132e3a383959acb7fa3795f12357",
"sha256": "9fbbbae77fe0300d3f23c9faaddf08657e3e40f08285f9aaace1e75ae12cff69"
},
"downloads": -1,
"filename": "amazon-q-developer-jupyterlab-ext-3.4.5.tar.gz",
"has_sig": false,
"md5_digest": "b419132e3a383959acb7fa3795f12357",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 420612,
"upload_time": "2024-11-21T22:09:21",
"upload_time_iso_8601": "2024-11-21T22:09:21.859265Z",
"url": "https://files.pythonhosted.org/packages/8a/b3/17337a6af7154133f77e9b096c3dfeaa30de753d7aa1397fb499e01b7eda/amazon-q-developer-jupyterlab-ext-3.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 22:09:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "amazon-q-developer-jupyterlab-ext"
}
JSON