matlab-proxy 0.26.0__tar.gz → 0.27.0__tar.gz

matlab_proxy-0.27.0/.gitignore

@@ -0,0 +1,16 @@
+*.egg-info/
+.eggs/
+__pycache__/
+build/
+dist/
+.venv*/
+htmlcov/
+.coverage
+*.key
+*.pem
+.python-version
+coverage.xml
+.ipynb_checkpoints/
+*.ipynb
+.env
+matlab_proxy/gui

{matlab_proxy-0.26.0/matlab_proxy.egg-info → matlab_proxy-0.27.0}/PKG-INFO

@@ -1,12 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: matlab-proxy
-Version: 0.26.0
+Version: 0.27.0
 Summary: Python® package enables you to launch MATLAB® and access it from a web browser.
-Home-page: https://github.com/mathworks/matlab-proxy/
-Author: The MathWorks, Inc.
-Author-email: cloud@mathworks.com
-License: MATHWORKS CLOUD REFERENCE ARCHITECTURE LICENSE
-Keywords: Proxy,MATLAB Proxy,MATLAB,MATLAB Javascript Desktop,MATLAB Web Desktop,Remote MATLAB Web Access
+Project-URL: Homepage, https://github.com/mathworks/matlab-proxy/
+Project-URL: Documentation, https://github.com/mathworks/matlab-proxy/blob/main/README.md
+Project-URL: Issues, https://github.com/mathworks/matlab-proxy/issues
+Author-email: "The MathWorks Inc." <cloud@mathworks.com>
+License-Expression: LicenseRef-MATHWORKS-CLOUD-REFERENCE-ARCHITECTURE-LICENSE
+License-File: LICENSE.md
+Keywords: MATLAB,MATLAB Javascript Desktop,MATLAB Proxy,MATLAB Web Desktop,Proxy,Remote MATLAB Web Access
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python
@@ -14,31 +16,40 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: ~=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
+Requires-Python: >=3.8
+Requires-Dist: aiohttp-session[secure]
 Requires-Dist: aiohttp>=3.7.4
-Requires-Dist: aiohttp_session[secure]
 Requires-Dist: importlib-metadata
 Requires-Dist: importlib-resources
 Requires-Dist: psutil
-Requires-Dist: watchdog
 Requires-Dist: requests
+Requires-Dist: watchdog
 Provides-Extra: dev
-Requires-Dist: aiohttp-devtools; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-env; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-timeout; extra == "dev"
-Requires-Dist: pytest-mock; extra == "dev"
-Requires-Dist: pytest-aiohttp; extra == "dev"
-Requires-Dist: pytest-timeout; extra == "dev"
-Requires-Dist: psutil; extra == "dev"
-Requires-Dist: urllib3; extra == "dev"
-Requires-Dist: pytest-playwright; extra == "dev"
-Requires-Dist: pytest-asyncio==0.24.0; extra == "dev"
+Requires-Dist: aiohttp-devtools; extra == 'dev'
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: psutil; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-aiohttp; extra == 'dev'
+Requires-Dist: pytest-asyncio==0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-env; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Requires-Dist: pytest-playwright; extra == 'dev'
+Requires-Dist: pytest-timeout; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: urllib3; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: psutil; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-aiohttp; extra == 'test'
+Requires-Dist: pytest-asyncio==0.24.0; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-env; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
+Requires-Dist: pytest-playwright; extra == 'test'
+Requires-Dist: pytest-timeout; extra == 'test'
+Requires-Dist: urllib3; extra == 'test'
+Description-Content-Type: text/markdown
 
 # MATLAB Proxy
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mathworks/matlab-proxy/run-tests.yml?branch=main&logo=github)](https://github.com/mathworks/matlab-proxy/actions) &nbsp; [![PyPI badge](https://img.shields.io/pypi/v/matlab-proxy.svg?logo=pypi)](https://pypi.python.org/pypi/matlab-proxy) &nbsp;  [![codecov](https://codecov.io/gh/mathworks/matlab-proxy/branch/main/graph/badge.svg?token=ZW3SESKCSS)](https://codecov.io/gh/mathworks/matlab-proxy) &nbsp; [![Downloads](https://static.pepy.tech/personalized-badge/matlab-proxy?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month)](https://pepy.tech/project/matlab-proxy)

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/gui/src/components/App/index.jsx

@@ -40,6 +40,7 @@ import {
     selectMatlabStarting,
     selectIsIdleTimeoutEnabled,
     selectMatlabStopping,
+    selectBrowserTitle,
     selectIntegrationName
 } from '../../selectors';
 
@@ -54,7 +55,7 @@ import blurredBackground from './MATLAB-env-blur.png';
 import EntitlementSelector from '../EntitlementSelector';
 import { BUFFER_TIMEOUT_DURATION, MWI_AUTH_TOKEN_NAME_FOR_HTTP } from '../../constants';
 
-function App () {   
+function App() {
     const dispatch = useDispatch();
 
     const overlayVisible = useSelector(selectOverlayVisible);
@@ -76,6 +77,7 @@ function App () {
     const isConcurrencyEnabled = useSelector(selectIsConcurrencyEnabled);
     const wasEverActive = useSelector(selectWasEverActive);
     const integrationName = useSelector(selectIntegrationName);
+    const browserTitle = useSelector(selectBrowserTitle);
 
     // Timeout duration is specified in seconds, but useTimeoutFn accepts timeout values in ms.
     const idleTimeoutDurationInMS = useSelector(selectIdleTimeoutDurationInMS);
@@ -93,7 +95,7 @@ function App () {
 
 
     // callback that will fire once the IDLE timer expires
-    function terminationFn () {
+    function terminationFn() {
         // Reset the timer if MATLAB is either starting or stopping or is busy
         if (isMatlabStarting || isMatlabStopping || isMatlabBusy) {
             idleTimerReset();
@@ -303,7 +305,7 @@ function App () {
         if (hasFetchedEnvConfig) {
             const queryParams = parseQueryParams(window.location);
             const token = queryParams.get(MWI_AUTH_TOKEN_NAME_FOR_HTTP);
-
+            document.title = `${browserTitle}`;
             if (token) {
                 dispatch(updateAuthStatus(token));
             }
@@ -331,7 +333,7 @@ function App () {
             overlayContent = <ShutdownWarning
                 bufferTimeout={BUFFER_TIMEOUT_DURATION}
                 resumeCallback={() => {
-                // Restart IDLE timer
+                    // Restart IDLE timer
                     idleTimerReset();
                     setIdleTimerHasExpired(false);
 
@@ -386,7 +388,7 @@ function App () {
     if (matlabUp) {
         matlabJsd = (!authEnabled || isAuthenticated)
             ? (<MatlabJsd handleUserInteraction={handleUserInteraction} url={matlabUrl} iFrameRef={MatlabJsdIframeRef} shouldListenForEvents={shouldListenForEvents} />)
-            : <img style={{ objectFit: 'fill' }}src={blurredBackground} alt='Blurred MATLAB environment'/>;
+            : <img style={{ objectFit: 'fill' }} src={blurredBackground} alt='Blurred MATLAB environment' />;
     }
 
     const overlayTrigger = overlayVisible

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/gui/src/selectors/index.js

@@ -260,9 +260,23 @@ export const selectIsIdleTimeoutEnabled = createSelector(
 export const selectIdleTimeoutDurationInMS = createSelector(
     selectIsIdleTimeoutEnabled,
     selectIdleTimeoutDuration,
-    (isTimeoutEnabled, idleTimeoutDuration) => { return isTimeoutEnabled
-        ? idleTimeoutDuration * 1000
-        : undefined; }
+    (isTimeoutEnabled, idleTimeoutDuration) => {
+        return isTimeoutEnabled
+            ? idleTimeoutDuration * 1000
+            : undefined;
+    }
+);
+
+export const selectBrowserTitle = createSelector(
+    selectHasFetchedEnvConfig,
+    selectEnvConfig,
+    (hasFetchedEnvConfig, envConfig) => {
+        if (hasFetchedEnvConfig) {
+            return envConfig.browserTitle;
+        } else {
+            return 'MATLAB';
+        }
+    }
 );
 
 export const selectIntegrationName = createSelector(

matlab_proxy-0.27.0/hatch_build.py

@@ -0,0 +1,73 @@
+# Copyright 2025 The MathWorks, Inc.
+
+import os
+import subprocess
+from pathlib import Path
+from shutil import which, copytree
+from typing import Any, Dict
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    #  Identifier that connects this Python hook class to pyproject.toml configuration
+    PLUGIN_NAME = "custom"
+
+    def initialize(self, version: str, build_data: Dict[str, Any]) -> None:
+        """Run npm install and build, then copy files to package."""
+
+        # Ensure npm is present
+        npm_path = which("npm")
+        if not npm_path:
+            raise Exception(
+                "npm must be installed and on the path during package build!"
+            )
+
+        npm_install = [npm_path, "install"]
+        npm_build = [npm_path, "run", "build"]
+
+        pwd = Path.cwd()
+        gui_path = pwd / "gui"
+        gui_build_path = gui_path / "build"
+
+        if not gui_path.exists():
+            raise Exception(f"GUI directory not found: {gui_path}")
+
+        # Cleanup the build folder to ensure latest artifacts are generated
+        if gui_build_path.exists():
+            import shutil
+
+            shutil.rmtree(gui_build_path)
+
+        # Change to directory where GUI files are present
+        original_cwd = str(pwd)
+        os.chdir(gui_path)
+
+        try:
+            # Install dependencies and build GUI files
+            subprocess.run(npm_install, check=True)
+            subprocess.run(npm_build, check=True)
+        finally:
+            os.chdir(original_cwd)
+
+        if not gui_build_path.exists():
+            raise Exception(f"GUI build directory not found: {gui_build_path}")
+
+        # Copy built files to a temporary location that will be included in wheel
+        temp_gui_path = pwd / "matlab_proxy" / "gui"
+        temp_gui_path.mkdir(parents=True, exist_ok=True)
+
+        # Cleanup pre-existing gui files
+        if temp_gui_path.exists():
+            import shutil
+
+            shutil.rmtree(temp_gui_path)
+
+        copytree(gui_build_path, temp_gui_path)
+
+        # Create __init__.py files to make directories into Python modules
+        (temp_gui_path / "__init__.py").touch(exist_ok=True)
+        for root, dirs, _ in os.walk(temp_gui_path):
+            for directory in dirs:
+                (Path(root) / directory / "__init__.py").touch(exist_ok=True)
+        print("Build hook step completed!")

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/app.py

@@ -209,6 +209,8 @@ async def get_env_config(req):
         "supportedVersions": constants.SUPPORTED_MATLAB_VERSIONS,
     }
 
+    config["browserTitle"] = state.settings["browser_title"]
+
     # Send timeout duration for the idle timer as part of the response
     config["idleTimeoutDuration"] = state.settings["mwi_idle_timeout"]
 
@@ -497,15 +499,11 @@ def make_static_route_table(app):
     Returns:
         Dict: Containing information about the static files and header information.
     """
-    import importlib_resources
-
-    from matlab_proxy import gui  # noqa: F401
-    from matlab_proxy.gui import static  # noqa: F401
-    from matlab_proxy.gui.static import (
-        css,  # noqa: F401
-        js,  # noqa: F401
-        media,  # noqa: F401
-    )
+    import importlib_resources as resources
+
+    from matlab_proxy import gui
+    from matlab_proxy.gui import static
+    from matlab_proxy.gui.static import css, js, media
 
     base_url = app["settings"]["base_url"]
 
@@ -513,14 +511,14 @@ def make_static_route_table(app):
 
     for mod, parent in [
         (gui.__name__, ""),
-        (gui.static.__name__, "/static"),
-        (gui.static.css.__name__, "/static/css"),
-        (gui.static.js.__name__, "/static/js"),
-        (gui.static.media.__name__, "/static/media"),
+        (static.__name__, "/static"),
+        (css.__name__, "/static/css"),
+        (js.__name__, "/static/js"),
+        (media.__name__, "/static/media"),
     ]:
-        for entry in importlib_resources.files(mod).iterdir():
+        for entry in resources.files(mod).iterdir():
             name = entry.name
-            if not importlib_resources.files(mod).joinpath(name).is_dir():
+            if not resources.files(mod).joinpath(name).is_dir():
                 if name != "__init__.py":
                     # Special case for manifest.json
                     if "manifest.json" in name:

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/app_state.py

@@ -896,8 +896,14 @@ class AppState:
 
         mwi_server_info_file = mwi_logs_dir / "mwi_server.info"
         mwi_auth_token_str = token_auth.get_mwi_auth_token_access_str(self.settings)
-        with open(mwi_server_info_file, "w") as fh:
-            fh.write(self.settings["mwi_server_url"] + mwi_auth_token_str + "\n")
+        with open(mwi_server_info_file, "w", encoding="utf-8") as fh:
+            fh.write(
+                self.settings["mwi_server_url"]
+                + mwi_auth_token_str
+                + "\n"
+                + self.settings["browser_title"]
+                + "\n"
+            )
         self.mwi_server_session_files["mwi_server_info_file"] = mwi_server_info_file
         logger.debug(f"Server info stored into: {mwi_server_info_file}")
 

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/default_configuration.py

@@ -1,4 +1,4 @@
-# Copyright 2020-2024 The MathWorks, Inc.
+# Copyright 2020-2025 The MathWorks, Inc.
 from enum import Enum
 from typing import List
 
@@ -45,7 +45,7 @@ def get_required_config() -> List[str]:
         list: A list of strings representing the required
         configuration keys.
     """
-    required_keys: List[str] = [
+    required_keys: List[ConfigKeys] = [
         ConfigKeys.DOC_URL,
         ConfigKeys.EXT_NAME,
         ConfigKeys.EXT_NAME_DESC,

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/settings.py

@@ -21,7 +21,7 @@ from matlab_proxy.constants import MWI_AUTH_TOKEN_NAME_FOR_HTTP
 from matlab_proxy.util import mwi, system
 from matlab_proxy.util.cookie_jar import HttpOnlyCookieJar
 from matlab_proxy.util.mwi import environment_variables as mwi_env
-from matlab_proxy.util.mwi import token_auth
+from matlab_proxy.util.mwi import token_auth, session_name
 from matlab_proxy.util.mwi.exceptions import (
     FatalError,
     MatlabInstallError,
@@ -222,6 +222,7 @@ def get_dev_settings(config):
         "is_windowmanager_available": False,
         "mwi_idle_timeout": None,
         "cookie_jar": _get_cookie_jar(),
+        "browser_title": session_name.get_browser_title("R2020b"),
     }
 
 
@@ -324,7 +325,6 @@ def get_server_settings(config_name):
     )
 
     cookie_jar = _get_cookie_jar()
-
     return {
         "create_xvfb_cmd": create_xvfb_cmd,
         "base_url": mwi.validators.validate_base_url(
@@ -406,6 +406,7 @@ def get_matlab_settings():
         **mw_licensing_urls,
         "nlm_conn_str": nlm_conn_str,
         "has_custom_code_to_execute": has_custom_code_to_execute,
+        "browser_title": session_name.get_browser_title(matlab_version),
     }
 
 

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/util/list_servers.py

@@ -31,8 +31,8 @@ def print_server_info():
         for server in search_results:
             server_number += 1
             with open(server) as f:
-                server_info = f.read()
-                print_output += str(server_number) + ".  " + str(server_info)
+                server_info = f.readline().strip()
+                print_output += str(server_number) + ".  " + str(server_info) + "\n"
 
     print_output += str(
         mwi_util.prettify(

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/util/mwi/environment_variables.py

@@ -172,6 +172,11 @@ def get_env_name_shutdown_on_idle_timeout():
     return "MWI_SHUTDOWN_ON_IDLE_TIMEOUT"
 
 
+def get_env_name_session_name():
+    """User specified session name for the MATLAB Proxy instance, used to set the browser title."""
+    return "MWI_SESSION_NAME"
+
+
 class Experimental:
     """This class houses functions which are undocumented APIs and Environment variables.
     Note: Never add any state to this class. Its only intended for use as an abstraction layer

matlab_proxy-0.27.0/matlab_proxy/util/mwi/session_name.py

@@ -0,0 +1,28 @@
+# Copyright 2025 The MathWorks, Inc.
+"""This file provides functions to set a session name for the MATLAB Proxy instance."""
+
+import os
+from matlab_proxy.util.mwi import environment_variables as mwi_env
+from matlab_proxy.util.mwi import logger as mwi_logger
+
+logger = mwi_logger.get()
+
+
+def _get_session_name():
+    """Get the session name for the MATLAB Proxy instance.
+
+    Returns:
+        str: returns the user-defined session name if set, otherwise returns None.
+    """
+    return os.getenv(mwi_env.get_env_name_session_name(), None)
+
+
+def get_browser_title(matlab_version) -> str:
+    """Get the browser title for the MATLAB Proxy instance."""
+
+    browser_title = "MATLAB " + (matlab_version or "")
+    session_name = _get_session_name()
+    if session_name:
+        browser_title = session_name + " - " + browser_title
+        logger.info("Session Name set to : %s", session_name)
+    return browser_title

{matlab_proxy-0.26.0 → matlab_proxy-0.27.0}/matlab_proxy/util/mwi/validators.py

@@ -214,11 +214,9 @@ def __get_configs():
         Dict: Contains all the values present in 'matlab_web_desktop_configs' entry_point from all the packages
         installed in the current environment.
     """
-    import importlib_metadata
+    import importlib_metadata as metadata
 
-    matlab_proxy_eps = importlib_metadata.entry_points(
-        group=matlab_proxy.get_entrypoint_name()
-    )
+    matlab_proxy_eps = metadata.entry_points(group=matlab_proxy.get_entrypoint_name())
     configs = {}
     for entry_point in matlab_proxy_eps:
         configs[entry_point.name.lower()] = entry_point.load()

matlab_proxy-0.27.0/matlab_proxy_manager/README.md

@@ -0,0 +1,85 @@
+# MATLAB Proxy Manager
+
+----
+This README is intended for MathWorks® developers only.
+`matlab-proxy-manager` is part of the `matlab-proxy` package and it helps in managing the lifecycle and proxying of MATLAB proxy processes.
+
+It provides a seamless integration with Jupyter environments, allowing MATLAB to be accessed and controlled via a proxy.
+
+Upon installation, this package introduces an executable `matlab-proxy-manager-app`, which is utilized by the Jupyter Server Proxy to initiate `matlab-proxy-manager`.
+
+----
+
+**Table of Contents**
+- [Project Structure](#structure)
+- [Installation](#installation)
+  - [PyPI](#pypi)
+  - [Building From Sources](#building-from-sources)
+- [Usage](#usage)
+- [Security](#security)
+
+## Structure
+`matlab-proxy-manager` is organized into several key sub-folders:
+
+1. lib: 
+
+    * This directory contains the library APIs that facilitate the invocation of MATLAB proxy processes. It supports API calls, enabling the MATLAB Kernel to manage proxy instances effectively. For detailed information, refer to the README within the lib folder.
+
+2. storage: 
+    * The file system serves as the source of truth for `matlab-proxy-manager`, storing metadata about each MATLAB proxy server in dedicated files. A new file is generated whenever a proxy instance is launched and is removed upon termination of the instance or deletion of the Kernel that initiated it.
+
+3. web: 
+    * This component handles proxy workflows through HTTP/WebSocket requests, which are part of the executable process spawned by clients using the `matlab-proxy-manager-app`. For specific requirements and constraints, consult the README located in the web folder.
+
+4. utils: 
+    * A collection of helper functions utilized across various parts of the project, ensuring modularity and code reuse.
+
+## Installation
+
+### PyPI
+`matlab-proxy-manager` is included in the `matlab-proxy` repository and can be easily installed from the Python Package Index:
+
+```bash
+python -m pip install matlab-proxy
+```
+
+### Building From Sources
+Building from sources requires Node.js® version 16 or higher. [Click here to install Node.js](https://nodejs.org/en/)
+
+```bash
+git clone https://github.com/mathworks/matlab-proxy.git
+
+cd matlab-proxy
+
+python -m pip install .
+```
+
+Installing the package creates an executable called `matlab-proxy-app`, which is placed onto your system PATH by `pip`, usually in: `$HOME/.local/bin/`
+```bash
+# Verify its presence on the PATH
+which matlab-proxy-manager-app
+```
+
+## Usage
+`matlab-proxy-manager` can be deployed in two modes:
+
+1. Library Mode: Import the relevant module within your client code to invoke public APIs directly.
+
+    Example:
+
+    ```python
+    import matlab_proxy_manager.lib.api as mpm_lib
+    response = await mpm_lib.start_matlab_proxy_for_kernel(...)
+    await mpm_lib.shutdown(...)
+    ```
+
+2. Process Mode: This mode is primarily managed by Jupyter-Server-Proxy for proxy workflows involving web-based MATLAB desktop access.
+
+## Security
+Security is paramount in matlab-proxy-manager. Communication between the Kernel, proxy manager, and Jupyter Server Proxy is secured using authentication tokens. These tokens are mandatory for API invocations and proxy workflows. They are passed via environment variables when the proxy manager is initiated by the Jupyter Server Proxy and are included in the arguments during Kernel API calls.
+
+---
+
+Copyright 2024 The MathWorks, Inc.
+
+---

matlab_proxy-0.27.0/matlab_proxy_manager/lib/README.md

@@ -0,0 +1,53 @@
+# MATLAB Proxy Manager - Library
+
+This README is intended for MathWorks® developers only.
+`matlab-proxy-manager` module is designed to be flexible and robust, supporting both direct library calls and process-based workflows. The lib folder contains the code blocks providing the core library APIs that facilitate the management of MATLAB proxy instances.
+
+# Key Features
+## API Invocation:
+
+The lib module allows for the invocation of MATLAB proxy processes through a well-defined set of APIs. These APIs are designed to be intuitive and easy to integrate into existing workflows, enabling developers to start, stop, and manage MATLAB proxy instances programmatically.
+
+## Integration with MATLAB Kernel:
+
+The APIs in the lib directory are used by the MATLAB Kernel to manage the lifecycle of MATLAB proxy instances. This includes starting new instances and shutting them down when they are no longer needed.
+
+## Error Handling and Logging:
+
+Comprehensive error handling mechanisms are in place to ensure that any issues encountered during the management of proxy instances are logged and reported. This aids in troubleshooting and ensures the reliability of the system. 
+
+Users are required to set `MWI_MPM_LOG_LEVEL` environment variable to their desired log level (`INFO`, `DEBUG` etc.) to enable logging in `matlab-proxy-manager`.
+
+# Usage
+To use the lib APIs, you can import the relevant module in your Python code and invoke the provided functions. Here’s a basic example of how you might start and stop a MATLAB proxy instance:
+
+```python
+
+import matlab_proxy_manager.lib.api as mpm_lib
+
+# Start a MATLAB proxy instance
+response = await mpm_lib.start_matlab_proxy_for_kernel(
+                caller_id=self.kernel_id,
+                parent_id=self.parent_pid,
+                is_shared_matlab=True,
+            )
+return (
+    response.get("absolute_url"),
+    response.get("mwi_base_url"),
+    response.get("headers"),
+    response.get("mpm_auth_token"),
+)
+
+# Perform operations with the MATLAB instance...
+
+# Shut down the MATLAB proxy instance
+await mpm_lib.shutdown(
+    self.parent_pid, self.kernel_id, self.mpm_auth_token
+)
+```
+
+---
+
+Copyright 2024 The MathWorks, Inc.
+
+---

matlab_proxy-0.27.0/matlab_proxy_manager/storage/README.md

@@ -0,0 +1,54 @@
+# MATLAB Proxy Manager - Storage
+
+This README is intended for MathWorks® developers only.
+The storage module is a critical part of the `matlab-proxy-manager`, responsible for managing the persistence of metadata related to MATLAB proxy instances. It employs a repository pattern to provide a clean and consistent interface for performing CRD (Create, Read, Delete) operations on the file system.
+
+## Key Features
+
+### Repository Pattern:
+
+The storage module is designed using the repository pattern, which abstracts the data layer and provides a straightforward API for interacting with stored metadata. This pattern ensures that the underlying data storage mechanism can be modified or replaced with minimal impact on the rest of the application.
+
+### File System-Based Storage:
+
+Currently, the storage operations are performed directly on the file system. Each MATLAB proxy instance's metadata is stored in a separate file, making it easy to manage and access individual instances.
+
+### CRD Operations:
+
+The storage module provides a set of APIs to perform CRD operations:
+
+1. add(...): Create a new metadata file for a MATLAB proxy instance.
+2. get(...): Retrieve metadata for a specific instance.
+3. get_all(): Retrieve metadata for all instances.
+4. delete(...): Remove the metadata file for a specific instance.
+
+Usage
+To use the storage APIs, clients can import the relevant module and invoke the provided functions. Here’s an example of how to perform basic CRUD operations:
+
+```python
+
+from matlab_proxy_manager.storage.file_repository import FileRepository
+
+storage = FileRepository(data_dir)
+
+# Add a new MATLAB proxy instance metadata
+filename = '1234.info'
+server_process = <instance of ServerProcess class>
+storage.add(server=server_process, filename=filename)
+
+# Retrieve metadata for a specific instance
+filename = f"{parent_pid}_{caller_id}"
+full_file_path, server = storage.get(filename)
+
+# Retrieve metadata for all instances
+servers = storage.get_all()
+
+# Delete metadata for a specific instance
+storage.delete(f"{filename}.info")
+```
+
+---
+
+Copyright 2024 The MathWorks, Inc.
+
+---