Metadata-Version: 2.4
Name: sagemaker-studio-dataengineering-extensions
Version: 1.0.8
Summary: A python Package to enhance experience of SageMaker Unified Studio
Author: Amazon Web Services
Maintainer: sagemaker-unified-studio
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Keywords: AWS,Amazon,Data Engineering,SageMaker,SageMaker Unified Studio
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.11
Requires-Dist: boto3
Requires-Dist: jupyter-server<3,>=1.6
Requires-Dist: pytest
Requires-Dist: requests
Requires-Dist: schedule
Description-Content-Type: text/markdown

# SageMakerStudioDataEngineeringExtensions

SageMaker Unified Studio Data Engineering Extensions

This package contains several extensions that enhance the experiences for SageMakerStudioDataEngineeringSessions.

This pacakge is depend on SageMaker Unified Studio environment.

## List of extensions

- SageMaker Connection Magic JupyterLab Extension
- SageMaker Data Explorer
- SageMaker Jupyter Server Extension
- SageMaker Spark Monitor
- SageMaker Unified Studio Theme
- SageMaker UI Doc Manger JupyterLag Plugin

## How to install these extensions

### Conda
For Conda users, if you install this package via Conda, all of these extensions are installed by default.

### PyPi
For PyPi users, you will need to go to each extension's subfolder and run `pip install .` to install the extension you want to use.

file structure is as follows:

```
sagemaker_studio_dataengineering_extensions
├── __init__.py
├── conftest.py
├── py.typed
├── sagemaker_connection_magics_jlextension
├── sagemaker_data_explorer
├── sagemaker_jupyter_server_extension
├── sagemaker_spark_monitor_widget
├── sagemaker_studio_theme
└── sagemaker_ui_doc_manager_jl_plugin
```

For example, if your python package is locate at `/opt/conda/lib/python3.11/site-packages`, you will need to go to path `/opt/conda/lib/python3.11/site-packages/sagemaker_studio_dataengineering_extensions/sagemaker_connection_magics_jlextension` and then run `pip install .` to install SageMaker Connection Magic JupyterLab Extension.

## Extension Details

### SageMaker Connection Magic JupyterLab Extension

This package contains a JupyterLab extension which provides a user-friendly experience for switching between different computes. For example, you can use this extension to easily switch from local python compute to different remote computes like EMR Cluster/Glue/EMR-Serverless.

### SageMaker Data Explorer

This package contains a JupyterLab extension which provides a side tab inside JupyterLab. That tab supports browsering data from different data source like Redshift/S3/LakeHouse.


### SageMaker Jupyter Server Extension

This package contains some Jupyter Server api to support other extensions in SageMaker Unified Studio.

### SageMaker Spark Monitor

This package contains a JupyterLab extension which provides a widget showing the progress of a running spark application in remote compute.

#### Setup

To load this extension, make sure you have iPython config file generated. If not, you could run `ipython profile create`, then a file with path `~/.ipython/profile_default/ipython_config.py` should be generated

Then you will need to add the following line in the end of that config file

```
c.InteractiveShellApp.extensions.extend(['sagemaker_sparkmonitor.kernelextension'])
```

once that config is added, restart the JupyterLab kernel to make the config change apply

### SageMaker Unified Studio Theme

This package contains a custom Theme for SageMaker Unified Studio

### SageMaker UI Doc Manger JupyterLag Plugin

This package is a JupyterLab extension which supports a shortcut from SageMaker Unified Studio portal to open a notebook in JupyterLab.