Amazon CodeGuru extension for JupyterLab and SageMaker Studio. This extension runs scans on your notebook files and provides security recommendations and quality improvements to your code.
- JupyterLab >= 3.0
pip install amazon_codeguru_jupyterlab_extension
pip uninstall amazon_codeguru_jupyterlab_extension
Ensure the following dependencies are available in your environment.
- Python >= 3.8
- JupyterLab >= 3.0
- NodeJS >= 18
Alternatively, you can create a conda virtual environment with the following commands:
conda env update --file binder/environment.yml
conda activate amazon-codeguru-extension-demo
- Install the Python package in development mode.
pip install -e .
- Link the extension with JupyterLab.
jupyter labextension develop . --overwrite
- Build the Typescript source.
jlpm build
# or
jlpm watch # automatically rebuild changes
- Start the JupyterLab server
jupyter lab
Run the following command to quickly build and install the extension.
python3 binder/postBuild
This extension can be distributed as a Python package. First, install build dependencies:
pip install build twine hatch
Bump the version using hatch
. By default this will create a tag.
hatch version <new-version>
To generate a new Python source package (.tar.gz
) and the binary package (.whl
) in the dist/
directory, run the following command:
python -m build
Then to upload the package to PyPI, run the following command:
twine upload dist/*
See SECURITY for more information.
This project is licensed under the Apache-2.0 License.