Metadata-Version: 2.4
Name: sagemaker-jupyterlab-extension-common
Version: 0.3.2
Summary: SageMaker JupyterLab workspace common module
Home-page: https://aws.amazon.com/sagemaker/
Author: Amazon
License: Amazon Software License
Keywords: Jupyter,JupyterLab,JupyterLab4
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: Jupyter
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3
Requires-Dist: jupyterlab>=4
Requires-Dist: jupyter-events>=0.6.0
Requires-Dist: aiobotocore>=2.7.0
Requires-Dist: aws_embedded_metrics
Requires-Dist: y-py<0.7.0,>=0.6.0
Requires-Dist: ypy-websocket>=0.12.0
Requires-Dist: nbformat>=5.9.2
Requires-Dist: pydantic<3,>=1.10.17
Requires-Dist: pyjwt<3.0.0,>=2.10.0
Provides-Extra: dev
Requires-Dist: pytest>=6; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: pytest_jupyter; extra == "dev"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# sagemaker_jupyterlab_extension_common

This package includes the common extensions built by SageMaker team that includes tools and utilities that can be shared by different extensions built by SageMaker. 

## Requirements
* JupyterLab >= 4
* aiobotocore
* aws_embedded_metrics

## Installing the extension
To install the extension within local Jupyter environment, a Docker image/container or in SageMaker Studio, run:
```
pip install sagemaker_jupyterlab_extension_common-<version>-py3-none-any.whl`
```

## Uninstalling the extension
To uninstall this extension, run:
```
pip uninstall sagemaker_jupyterlab_extension_common`
```

### Troubleshooting
If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

```
jupyter serverextension list
```

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:
```
jupyter labextension list
```

If the frontend extension is installed and enabled, open Browser console and see if there are any JavaScript error that is related to the extension in Browser console.

## See DEVELOPING.md for more instructions on dev setup and contributing guidelines


### Deployment

- Publishing to Conda happens through the Conda Forge feedstock repository. Once new version has been deployed to Pypi, create a new Github issue similar to this one https://github.com/conda-forge/sagemaker-jupyterlab-extension-common-feedstock/issues/30 and it will trigger new Conda Forge version release as a Pull Request.


### Links

- Pypi -> https://pypi.org/project/sagemaker-jupyterlab-extension-common
- Conda Forge -> https://anaconda.org/conda-forge/sagemaker-jupyterlab-extension-common
