# Amazon CodeWhisperer for JupyterLab
Amazon CodeWhisperer is an AI coding companion which provides developers with real-time code suggestions in JupyterLab. Individual developers can use CodeWhisperer for free in JupyterLab and AWS SageMaker Studio.
## Requirements
In order to use CodeWhisperer in JupyterLab, you must have a version of JupyterLab >= 4 installed. The previous major version of CodeWhisperer 1.x extension supports JupyterLab >= 3.5, <4. 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 CodeWhisperer. (You can set that up the first time you log in.)
In order to use CodeWhisperer 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 CodeWhisperer extension for JupyterLab 4 with the following commands.
```
# JupyterLab 4
pip install amazon-codewhisperer-jupyterlab-ext
```
### Installation Using Pip for Jupyter Lab version >= 3.6 and < 4.0
You can install and enable the CodeWhisperer 1.x extension for JupyterLab 3 with the following commands.
```
# JupyterLab 3
pip install amazon-codewhisperer-jupyterlab-ext~=1.0
jupyter server extension enable amazon_codewhisperer_jupyterlab_ext
```
Once installed, choose ****Start CodeWhisperer**** from the CodeWhisperer 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 CodeWhisperer. Refer to [Setting up CodeWhisperer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html) for detailed setup instructions.
### SageMaker Studio
To setup the CodeWhisperer 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-codewhisperer-jupyterlab-ext~=1.0
jupyter server extension enable amazon_codewhisperer_jupyterlab_ext
conda deactivate
restart-jupyter-server
```
After you complete installation and refresh your browser, a CodeWhisperer panel will appear at the bottom of the window. Refer to [Setting up CodeWhisperer with SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html) for detailed setup instructions.
## Features
### Code Completion
CodeWhisperer 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 CodeWhisperer | 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 CodeWhisperer 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 CodeWhisperer.
To view Code References for accepted suggestions, choose **Open Code Reference Log** from the CodeWhisperer panel at the bottom of the window. Users can also turn off code suggestions with code references in Settings.
## More Resources
* [CodeWhisperer User Guide](https://docs.aws.amazon.com/codewhisperer/latest/userguide/what-is-cwspr.html)
* [Setting up Amazon CodeWhisperer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html)
* [Setting up CodeWhisperer with Amazon SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html)
## Change Log
2.0.1
* Improved handling when Jupyter has no access to internet.
* Migrated network call to be made asynchronously.
2.0.0
* Initial release - Adoption of JupyterLab 4
Raw data
{
"_id": null,
"home_page": "https://aws.amazon.com/codewhisperer/",
"name": "amazon-codewhisperer-jupyterlab-ext",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab4,Amazon CodeWhisperer,CodeWhisperer,Code,Whisperer",
"author": "Amazon CodeWhisperer",
"author_email": "codewhisperer@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/2e/2d/c66d3dbd678945c905a2ef0727f2bf72fbe5c60d68496336d197f6bb34bb/amazon-codewhisperer-jupyterlab-ext-2.0.1.tar.gz",
"platform": "Linux",
"description": "# Amazon CodeWhisperer for JupyterLab\n\nAmazon CodeWhisperer is an AI coding companion which provides developers with real-time code suggestions in JupyterLab. Individual developers can use CodeWhisperer for free in JupyterLab and AWS SageMaker Studio.\n\n\n\n## Requirements\n\nIn order to use CodeWhisperer in JupyterLab, you must have a version of JupyterLab >= 4 installed. The previous major version of CodeWhisperer 1.x extension supports JupyterLab >= 3.5, <4. 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 CodeWhisperer. (You can set that up the first time you log in.)\n\nIn order to use CodeWhisperer 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 CodeWhisperer extension for JupyterLab 4 with the following commands. \n\n```\n# JupyterLab 4\npip install amazon-codewhisperer-jupyterlab-ext\n```\n\n### Installation Using Pip for Jupyter Lab version >= 3.6 and < 4.0\n\nYou can install and enable the CodeWhisperer 1.x extension for JupyterLab 3 with the following commands. \n\n```\n# JupyterLab 3\npip install amazon-codewhisperer-jupyterlab-ext~=1.0\njupyter server extension enable amazon_codewhisperer_jupyterlab_ext\n```\n\nOnce installed, choose ****Start CodeWhisperer**** from the CodeWhisperer 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 CodeWhisperer. Refer to [Setting up CodeWhisperer 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 CodeWhisperer 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-codewhisperer-jupyterlab-ext~=1.0\njupyter server extension enable amazon_codewhisperer_jupyterlab_ext\nconda deactivate\nrestart-jupyter-server\n```\n\nAfter you complete installation and refresh your browser, a CodeWhisperer panel will appear at the bottom of the window. Refer to [Setting up CodeWhisperer 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\nCodeWhisperer 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 CodeWhisperer | 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 CodeWhisperer 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 CodeWhisperer.\n\nTo view Code References for accepted suggestions, choose **Open Code Reference Log** from the CodeWhisperer 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* [CodeWhisperer User Guide](https://docs.aws.amazon.com/codewhisperer/latest/userguide/what-is-cwspr.html)\n* [Setting up Amazon CodeWhisperer with JupyterLab](https://docs.aws.amazon.com/codewhisperer/latest/userguide/jupyterlab-setup.html)\n* [Setting up CodeWhisperer with Amazon SageMaker Studio](https://docs.aws.amazon.com/codewhisperer/latest/userguide/sagemaker-setup.html)\n\n## Change Log\n\n2.0.1\n* Improved handling when Jupyter has no access to internet.\n* Migrated network call to be made asynchronously.\n\n2.0.0\n* Initial release - Adoption of JupyterLab 4\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Amazon CodeWhisperer for JupyterLab",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://aws.amazon.com/codewhisperer/"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab4",
"amazon codewhisperer",
"codewhisperer",
"code",
"whisperer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e2dc66d3dbd678945c905a2ef0727f2bf72fbe5c60d68496336d197f6bb34bb",
"md5": "3a4f11fbc469df29c2673acc7d4e589e",
"sha256": "0c7893337c024b142cca133d346b1871f4e922120408a85c3908b582fc27a54e"
},
"downloads": -1,
"filename": "amazon-codewhisperer-jupyterlab-ext-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3a4f11fbc469df29c2673acc7d4e589e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 120822,
"upload_time": "2023-12-08T23:56:13",
"upload_time_iso_8601": "2023-12-08T23:56:13.060102Z",
"url": "https://files.pythonhosted.org/packages/2e/2d/c66d3dbd678945c905a2ef0727f2bf72fbe5c60d68496336d197f6bb34bb/amazon-codewhisperer-jupyterlab-ext-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 23:56:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "amazon-codewhisperer-jupyterlab-ext"
}
JSON