matlab-proxy 0.25.1__py3-none-any.whl → 0.27.0__py3-none-any.whl

matlab_proxy/settings.py

@@ -19,8 +19,9 @@ import matlab_proxy
 from matlab_proxy import constants
 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,
@@ -159,7 +160,7 @@ def get_mwi_config_folder(dev=False):
             config_folder_path = config_folder_path / "hosts" / hostname
 
         logger.debug(
-            f"{'Hostname could not be determined. ' if not hostname else '' }Using the folder: {config_folder_path} for storing all matlab-proxy related session information"
+            f"{'Hostname could not be determined. ' if not hostname else ''}Using the folder: {config_folder_path} for storing all matlab-proxy related session information"
         )
 
         return config_folder_path
@@ -220,6 +221,8 @@ def get_dev_settings(config):
         "is_xvfb_available": False,
         "is_windowmanager_available": False,
         "mwi_idle_timeout": None,
+        "cookie_jar": _get_cookie_jar(),
+        "browser_title": session_name.get_browser_title("R2020b"),
     }
 
 
@@ -321,6 +324,7 @@ def get_server_settings(config_name):
         else f"{short_desc} - MATLAB Integration"
     )
 
+    cookie_jar = _get_cookie_jar()
     return {
         "create_xvfb_cmd": create_xvfb_cmd,
         "base_url": mwi.validators.validate_base_url(
@@ -359,6 +363,7 @@ def get_server_settings(config_name):
         "mwi_idle_timeout": mwi.validators.validate_idle_timeout(
             os.getenv(mwi_env.get_env_name_shutdown_on_idle_timeout())
         ),
+        "cookie_jar": cookie_jar,
     }
 
 
@@ -401,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),
     }
 
 
@@ -700,3 +706,19 @@ def _get_matlab_cmd(matlab_executable_path, code_to_execute, nlm_conn_str):
         "-r",
         code_to_execute,
     ]
+
+
+def _get_cookie_jar():
+    """Returns an instance of HttpOnly cookie jar if MWI_USE_COOKIE_CACHE environment variable is set to True
+
+    Returns:
+        HttpOnlyCookieJar: An instance of HttpOnly cookie jar if MWI_USE_COOKIE_CACHE environment variable is set to True, otherwise None.
+    """
+    cookie_jar = None
+    if mwi_env.Experimental.should_use_cookie_cache():
+        logger.info(
+            f"Environment variable {mwi_env.Experimental.get_env_name_use_cookie_cache()} is set. matlab-proxy server will cache cookies from MATLAB"
+        )
+        cookie_jar = HttpOnlyCookieJar()
+
+    return cookie_jar

matlab_proxy/util/cookie_jar.py

@@ -0,0 +1,72 @@
+# Copyright 2025 The MathWorks, Inc.
+
+from http.cookies import Morsel, SimpleCookie
+from typing import Dict
+
+from matlab_proxy.util import mwi
+
+logger = mwi.logger.get()
+
+
+# For more information about HttpOnly attribute
+# of a cookie, check: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie#httponly
+class HttpOnlyCookieJar:
+    """
+    A lightweight, HttpOnly, in-memory cookie store.
+
+    Its sole responsibility is to parse and store 'Set-Cookie' headers as Morsel objects and
+    store them in the cookie-jar only if they are marked as HttpOnly.
+    """
+
+    def __init__(self):
+        self._cookie_jar: Dict[str, Morsel] = {}
+        logger.debug("Cookie Jar Initialized")
+
+    def _get_cookie_name(self, cookie: SimpleCookie) -> str:
+        """
+        Returns the name of the cookie.
+        """
+        return list(cookie.keys())[0]
+
+    def update_from_response_headers(self, headers) -> None:
+        """
+        Parses 'Set-Cookie' headers from a response and stores the resulting
+        cookie objects (Morsels) only if they are HttpOnly cookies.
+        """
+        for set_cookie_val in headers.getall("Set-Cookie", []):
+            cookie = SimpleCookie()
+            cookie.load(set_cookie_val)
+            cookie_name = self._get_cookie_name(cookie)
+            morsel = cookie[cookie_name]
+
+            if morsel["httponly"]:
+                self._cookie_jar[cookie_name] = morsel
+                logger.debug(
+                    f"Stored cookie object for key '{cookie_name}'. Value: '{cookie[cookie_name]}'"
+                )
+
+            else:
+                logger.warning(
+                    f"Cookie {cookie_name} is not a HttpOnly cookie. Skipping it."
+                )
+
+    def get_cookies(self):
+        """
+        Returns a copy of the internal dictionary of stored cookie Morsels.
+        """
+        return list(self._cookie_jar.values())
+
+    def get_dict(self) -> Dict[str, str]:
+        """
+        Returns the stored cookies as a simple dictionary of name-to-value strings,
+        which is compatible with aiohttp's 'LooseCookies' type.
+        """
+        loose_cookies = {
+            name: morsel.value for name, morsel in self._cookie_jar.items()
+        }
+        return loose_cookies
+
+    def clear(self):
+        """Clears all stored cookies."""
+        logger.info("Cookie Jar Cleared")
+        self._cookie_jar.clear()

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/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
@@ -198,3 +203,13 @@ class Experimental:
     def is_matlab_startup_profiling_enabled():
         """Returns true if the startup profiling is enabled."""
         return _is_env_set_to_true(Experimental.get_env_name_profile_matlab_startup())
+
+    @staticmethod
+    def get_env_name_use_cookie_cache():
+        """Returns the environment variable name used to enable cookie jar support for matlab-proxy"""
+        return "MWI_USE_COOKIE_CACHE"
+
+    @staticmethod
+    def should_use_cookie_cache():
+        """Returns true if the cookie jar support is enabled."""
+        return _is_env_set_to_true(Experimental.get_env_name_use_cookie_cache())

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/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.25.1.dist-info → matlab_proxy-0.27.0.dist-info}/METADATA

@@ -1,12 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: matlab-proxy
-Version: 0.25.1
+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,28 +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-Dist: aiohttp>=3.7.4
+Requires-Python: >=3.8
 Requires-Dist: aiohttp-session[secure]
+Requires-Dist: aiohttp>=3.7.4
 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: 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: psutil; extra == "dev"
-Requires-Dist: urllib3; extra == "dev"
-Requires-Dist: pytest-playwright; 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.25.1.dist-info → matlab_proxy-0.27.0.dist-info}/RECORD

@@ -1,20 +1,20 @@
 matlab_proxy/__init__.py,sha256=6cwi8buKCMtw9OeWaOYUHEoqwl5MyJ_s6GxgNuqPuNg,1673
-matlab_proxy/app.py,sha256=-lqRLDnDVdz01tPTzE58mRfxxqLKSUptXsI746a6i_k,34566
-matlab_proxy/app_state.py,sha256=jiPSjLZt4UHRElGaYMHf2o6kJXhliwER61mQZeezX0o,73407
-matlab_proxy/constants.py,sha256=So0UJC1QGvP4-nJWhau-xOlzBEdDpdExynzzbvEhtqk,1189
-matlab_proxy/default_configuration.py,sha256=tBHaEq_bYsX2uC9pPA9mi_8M6o94ij-rxq8mbvcYpFc,1874
+matlab_proxy/app.py,sha256=QPBSPDneHvqH7T6NHN-bGxluEjHS-fkYGDC0TVDZKvE,37490
+matlab_proxy/app_state.py,sha256=oijVEr2iBSu1bf-Pc7Mr8-mVFsPDqE81xkDrOcwN504,73559
+matlab_proxy/constants.py,sha256=gYpS3mls1i3cO4eExbqQO-z_h8QIWTkM9h2S_EAMWSU,1257
+matlab_proxy/default_configuration.py,sha256=7xjsCzma4c6u0rEzio8xhHaDRy0wY2xtGXuARY2v0hc,1881
 matlab_proxy/devel.py,sha256=nR6XPVBUEdQ-RZGtYvX1YHTp8gj9cuw5Hp8ahasMBc8,14310
-matlab_proxy/settings.py,sha256=31WrxQjqJWpvwU_4dehmkadaj8Vvn-8p8SZljFQDd8s,28540
+matlab_proxy/settings.py,sha256=yKnjprDNml-wO4Ae-6MiGa9EG1NIzvh-HaCGu-loQBg,29480
 matlab_proxy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 matlab_proxy/gui/favicon.ico,sha256=7w7Ki1uQP2Rgwc64dOV4-NrTu97I3WsZw8OvRSoY1A0,130876
-matlab_proxy/gui/index.html,sha256=RxJRnpMXIL8_PYz_PkzbgK_cnXR9IWnYJ4XmwJGKfwY,720
+matlab_proxy/gui/index.html,sha256=DsOZs5RaM72cflhcqV8UUZ8NwS09JlcZG-zlN5XfUcE,720
 matlab_proxy/gui/manifest.json,sha256=NwDbrALM5auYyj2bbEf4aGwAUDqNl1FzMFQpPiG2Ty4,286
 matlab_proxy/gui/robots.txt,sha256=kNJLw79pisHhc3OVAimMzKcq3x9WT6sF9IS4xI0crdI,67
 matlab_proxy/gui/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 matlab_proxy/gui/static/css/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 matlab_proxy/gui/static/css/index.BSVLACuY.css,sha256=LzuRvV10Z0pF0ugGSnj5zKJvT4AHwwBbCd-wSH4mHjg,305333
 matlab_proxy/gui/static/js/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-matlab_proxy/gui/static/js/index.CZgGkMCD.js,sha256=_dyS-iqHSRqu323RTBaNMXxGdYEkVcEv4IqB6hBc3C8,279990
+matlab_proxy/gui/static/js/index.BcDShXfH.js,sha256=9_MsXzl9doo6Lniy_MxwMZe3VlJGepCDsdJ_3mxsKQk,280073
 matlab_proxy/gui/static/media/MATLAB-env-blur.NupTbPv_.png,sha256=QpmQTLDvBu2-b7ev83Rvpt0Q72R6wdQGkuJMPPpjv7M,220290
 matlab_proxy/gui/static/media/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 matlab_proxy/gui/static/media/glyphicons-halflings-regular.BKjkU69z.woff,sha256=omOU9-3hAMoRjv8u2ghZYnWpg5uVnCJuFUOVV6WoB0I,23424
@@ -40,75 +40,48 @@ matlab_proxy/icons/matlab.svg,sha256=xh5uYebQd8I-ISvenjU9A-PkClzW_lU9wvm3doXOFKM
 matlab_proxy/matlab/evaluateUserMatlabCode.m,sha256=R8w6nPdGtadR4UUFJaspcrGQL7cJwUItdrfc531w3bM,2420
 matlab_proxy/matlab/startup.m,sha256=UcA4i2lAMytwBsO783uPIQoP5Pzw1R0xrUywbBBtTjw,533
 matlab_proxy/util/__init__.py,sha256=JkVIsTOae5giDK0cQ7jcxQSHa8zo1umdq-1C0grDZwk,11712
+matlab_proxy/util/cookie_jar.py,sha256=GceKyB53lTX5r2wp9myvf0JDWDfvSamvjb4zmjkoOtY,2401
 matlab_proxy/util/event_loop.py,sha256=sX_0tKlirCY5ImLxkss_XO4Ksj65u6JHtwMj25oGL94,1816
-matlab_proxy/util/list_servers.py,sha256=M93coVZjyQCdIvCCxsNOU_XDWNjBSysOJ5tWXaTjP8Y,1369
+matlab_proxy/util/list_servers.py,sha256=vdagTACoNM9zxJHeagAF7EbQNV-BjFsinf4JSX8H3SE,1388
 matlab_proxy/util/mw.py,sha256=dLGSdfcTZiwKR1MMZA-39o-8na13IEPZOGBqcaHmKVI,11086
 matlab_proxy/util/system.py,sha256=XoT3Rv5MwPkdfhk2oMvUwxxlzZmADMlxzi9IRQyGgbA,1692
 matlab_proxy/util/windows.py,sha256=_5gl2IyHIfw8-D3_G5uHkycZVGGFVXtjkd6_aP3g2Ts,3785
 matlab_proxy/util/mwi/__init__.py,sha256=zI-X1lafr8H3j17PyA0oSZ0q5nINfK-WDA7VmJKmSAQ,158
 matlab_proxy/util/mwi/custom_http_headers.py,sha256=kfDjSnEXEVzoF2pZuEn76LKayeD2WKoQEDu2Y9EMOAo,7154
 matlab_proxy/util/mwi/download.py,sha256=-GJj3yOsL4vF_9baqRXkgBI-vu_OwjZMQVkJXFS8GMc,4965
-matlab_proxy/util/mwi/environment_variables.py,sha256=ffKEm56nt18CKYLaTihfAyqhzgYRdtNfHSu3e1Fw1yg,6568
+matlab_proxy/util/mwi/environment_variables.py,sha256=1toY2D1vybmNin0jq-vhx86B2bXAUpb5Njw0soyaiTQ,7134
 matlab_proxy/util/mwi/exceptions.py,sha256=8o4PZmira_ZonnOROzu8ERIiSn9y-456JO89gqjCags,5446
 matlab_proxy/util/mwi/logger.py,sha256=GoisSphy3Jyi5-6-X0WRl1YkdrKx2xzjSxBN_w3oTU8,3802
+matlab_proxy/util/mwi/session_name.py,sha256=HQAGMlJo6KMb2f9MBcavni48nw9H-cHWMeJKmXxpeys,915
 matlab_proxy/util/mwi/token_auth.py,sha256=UbIWqo7qADaZdijFvorLYsZbxzaB8TycGP8nk305ru0,9997
-matlab_proxy/util/mwi/validators.py,sha256=dg2OXL686vWie_JoTNpFSje2m_UqdpvpTVHJl5tmxSo,13247
+matlab_proxy/util/mwi/validators.py,sha256=tofVI81DT0KinxZ99XeN96ybkwz-6Lt-e-tN7PXkolk,13235
 matlab_proxy/util/mwi/embedded_connector/__init__.py,sha256=Vfl2hNC7V1IwoK9_wrwfENs4BC8P-Mvvqh4BNGi2n48,119
 matlab_proxy/util/mwi/embedded_connector/helpers.py,sha256=kpIgJN0AqYLeX56UylWgB0t07fg8sh0RhIlUH_8JitM,3654
 matlab_proxy/util/mwi/embedded_connector/request.py,sha256=RXoVvrm5fibVb2A6EZnkMWwAQkYX3J5kqDTGQDZo9p0,4316
+matlab_proxy_manager/README.md,sha256=7F9KyrilUWhPH5qZtKHB_6iZK5cVRuccJr0LroP1hXo,3431
 matlab_proxy_manager/__init__.py,sha256=CMqm2aSYUWo5sxV3vyqWudrQU31muouSqZRDesJNJSA,178
+matlab_proxy_manager/lib/README.md,sha256=233q4O0NzLzeOTWsCrHIboU-i-NAMb-SBq5SBMDwyhk,2193
 matlab_proxy_manager/lib/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
-matlab_proxy_manager/lib/api.py,sha256=L-yPrDqaBQ-AA1ds5PndzglBO1oglGJxy-x0F1lZZj4,12640
+matlab_proxy_manager/lib/api.py,sha256=rDnxA599DZI73TUBSn8JPCbmKM_kn_T_J0dw0z4Kg5M,14380
+matlab_proxy_manager/storage/README.md,sha256=OmToUE1lD7evUtmg0yCc9oHlqg5mN4rzmePfHwuXYC0,2106
 matlab_proxy_manager/storage/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
 matlab_proxy_manager/storage/file_repository.py,sha256=U4FAw0zFN9z7YNlaMsYZXWm5ccs3rp3bzZL-W2BNhxA,5187
 matlab_proxy_manager/storage/interface.py,sha256=pnRRD0Ku3gzbruAOM3J3NI2Kk8do3-_yRw9Pag1IqnE,1883
-matlab_proxy_manager/storage/server.py,sha256=8-kv3R7dJJYfOStYGjYj1nBt2Jn3o3qnn75YVAmwFSc,6010
+matlab_proxy_manager/storage/server.py,sha256=DuYl9Q-gYA71WElBHcKMd1N5LW5k_Ey0PGABuLAQrgM,6150
 matlab_proxy_manager/utils/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
 matlab_proxy_manager/utils/auth.py,sha256=60vi16eQ7LWp3I4CNv2easTjObw50irEm518fiMA5YI,2526
-matlab_proxy_manager/utils/constants.py,sha256=pyg-bkk6wWfmy60nvhroZDMZt__FcbZbuvU-b9m2Fkg,163
-matlab_proxy_manager/utils/environment_variables.py,sha256=rbDeWnyJp77Yr6btK3eXKZQ5thwiwhOGZcvDetGPOH8,1436
-matlab_proxy_manager/utils/helpers.py,sha256=vgbWDTGmHpI_IMEy67UMfExxmbjMskhdEadCmbbvav8,9983
-matlab_proxy_manager/utils/logger.py,sha256=GSRGD-yf518o-2b1BxEeJYuNiEz2eEqpl0Solqbwpb4,1869
+matlab_proxy_manager/utils/constants.py,sha256=jI6g31m7xt9DFoe5Qj2Axb3lz6O_wTBvRqHz8RnUKKA,226
+matlab_proxy_manager/utils/environment_variables.py,sha256=A1E4RfSR21vWlWuoFy0JrRXbNsDtmlXI2tRqJT8jzcc,1612
+matlab_proxy_manager/utils/exceptions.py,sha256=t_LykVJx7A4M-G6vg43PgzK7u7zE8i1c6aMhLSpqQOQ,1217
+matlab_proxy_manager/utils/helpers.py,sha256=_BH4qvJwfJYdfdv0I6dbugQjNJ_wxnUsfD5OrsPvCCM,9989
+matlab_proxy_manager/utils/logger.py,sha256=HCQNjF0rHbDBvKhMBxGWs-FVH_GLTUDKIyXDqzLMAzc,1986
+matlab_proxy_manager/web/README.md,sha256=_RADHyuBhVZiZmHV7vKXkKkxyh9c-z-rzxr67pssxQI,2578
 matlab_proxy_manager/web/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
-matlab_proxy_manager/web/app.py,sha256=a_fCQS1rDGCuQ7iE1J2oaFrKSeBUyk_9lYeuyZo-MVc,18174
+matlab_proxy_manager/web/app.py,sha256=-sfeJ4ltvcT1-8m0rOZkn357XQTSSNSPIUb3fidT71Y,20643
 matlab_proxy_manager/web/monitor.py,sha256=PWkwV0kP3XHCxDRHpurPh74Zg-SgaIXnCnX2xZSW_R8,1541
 matlab_proxy_manager/web/watcher.py,sha256=89JHjBAQtOrllstaJFxqrjHwckpRmu3qfUqeqPLmH2Q,2130
-tests/integration/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
-tests/integration/integration_tests_with_license/__init__.py,sha256=vVYZCur-QhmIGCxUmn-WZjIywtDQidaLDmlmrRHRlgY,37
-tests/integration/integration_tests_with_license/conftest.py,sha256=sCaIXB8d4vf05C7JWSVA7g5gnPjbpRq3dftuBpWyp1s,1599
-tests/integration/integration_tests_with_license/test_http_end_points.py,sha256=SDqYARwZKNXDS8-GzRKZvttCbmjq5ETwduN61ZVgOk8,14441
-tests/integration/integration_tests_without_license/__init__.py,sha256=vVYZCur-QhmIGCxUmn-WZjIywtDQidaLDmlmrRHRlgY,37
-tests/integration/integration_tests_without_license/conftest.py,sha256=n-oppKWxavyy1O0J6DywO3DnOHuYc7yUZRXm3Bt4szU,3526
-tests/integration/integration_tests_without_license/test_matlab_is_down_if_unlicensed.py,sha256=tkdyhfZBpfJpbnEzjURyV-GE0p43YxOa9xooJf-JoM4,1653
-tests/integration/utils/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
-tests/integration/utils/integration_tests_utils.py,sha256=IbJ9CedFHiz3k85FBY-8GwotTnjPF3jF4AHdKio7jqk,10321
-tests/integration/utils/licensing.py,sha256=rEBjvMXO8R3mL6KnePu2lojmOsjD4GXl9frf9N0Wacs,4842
-tests/unit/__init__.py,sha256=KfwQxxM5a1kMRtNbhz8tb7YfHp8e2d0tNLB55wYvDS8,37
-tests/unit/conftest.py,sha256=FIL7bhw2-9B5OEspqt9toZ2ZlN18pOsPEFjeQmVNcSk,1916
-tests/unit/test_app.py,sha256=VZt64uhdhsdmZL3Pb9LGtxxgt0H18mzRZRzSyiud6nQ,40028
-tests/unit/test_app_state.py,sha256=ZhywxbZb9HCxLQjgW1QEHccaydCeGKX20YOFFjpKWYM,38047
-tests/unit/test_constants.py,sha256=2nXxTmDP8utr8krsfZ4c_Bh4_mWPcDO5uI8MXeq4Usg,158
-tests/unit/test_ddux.py,sha256=a2J2iM8j_nnfJVuMI38p5AjwrRdoMj3N88gFgS2I4hg,713
-tests/unit/test_devel.py,sha256=A-1iVhSSwmywaW65QIRcUS2Fk7nJxceCcCm7CJtNdEc,7982
-tests/unit/test_non_dev_mode.py,sha256=Jqs5W-ax6WNM9v5SeTjpmVsojjA95itPC8Lqhs2U3Oc,5533
-tests/unit/test_settings.py,sha256=CZDopczxa7zMC1LIpRckwnG4v2Ag4RBLqPE1TaypNYM,23271
-tests/unit/util/__init__.py,sha256=GInSQBb2SoVD5LZfmSCQa9-UZJT_UP-jNfrojkgCybU,87
-tests/unit/util/test_mw.py,sha256=hweBw3ijcdh_2QdECjAWNkmh_7P5Df728cgD51DFkT8,18571
-tests/unit/util/test_util.py,sha256=n-xSkwdqXfq550jWYsmjhGjx6L98URhWeLJLKhGekOw,7476
-tests/unit/util/mwi/__init__.py,sha256=pl5jqyCHEwZEviiL8OC-SHulb1rBecstQCFF6qVjL9Y,37
-tests/unit/util/mwi/test_custom_http_headers.py,sha256=UfrhclS0j6WhShtg1ki2oF1kK8JqRC29uevH4tuDqF4,11182
-tests/unit/util/mwi/test_download.py,sha256=jYwPJFYGrPKqnkIJW42XYSe1fowmzChAkOx0k0xVldo,4779
-tests/unit/util/mwi/test_logger.py,sha256=S0Q5TirFxysrH2YSxRzGY9mWoWB83hG3q3XpGENCpcw,3150
-tests/unit/util/mwi/test_token_auth.py,sha256=0gp41Y7zZFqeFDCA0V3Arv_CqnQKo5RZqijIccvezYM,10562
-tests/unit/util/mwi/test_validators.py,sha256=GvLP3lSvoOQAjoclYunKPfxPIagUsnVGHRskHELResE,11765
-tests/unit/util/mwi/embedded_connector/__init__.py,sha256=pl5jqyCHEwZEviiL8OC-SHulb1rBecstQCFF6qVjL9Y,37
-tests/unit/util/mwi/embedded_connector/test_helpers.py,sha256=vYTWNUTuDeaygo16JGMTvWeI_CLOnvPkwNJmLndvJhE,890
-tests/unit/util/mwi/embedded_connector/test_request.py,sha256=PR-jddnXDEiip-lD7A_QSvRwEkwo3eQ8owZlk-r9vnk,1867
-tests/utils/__init__.py,sha256=ttzJ8xKWGxOJZz56qOiWOn6sp5LGomkZMn_w4KJLRMU,42
-tests/utils/logging_util.py,sha256=VBy_NRvwau3C_CVTBjK5RMROrQimnJYHO2U0aKSZiRw,2234
-matlab_proxy-0.25.1.dist-info/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
-matlab_proxy-0.25.1.dist-info/METADATA,sha256=TGXteKmTuOYE0iJL7VSG16c4522mPBGBqcpX7bRMwuU,10576
-matlab_proxy-0.25.1.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-matlab_proxy-0.25.1.dist-info/entry_points.txt,sha256=3wztwXpt6wdGfTwscc4qHbCeWzi0E2XhyJbMDndyQKc,304
-matlab_proxy-0.25.1.dist-info/top_level.txt,sha256=KF-347aoRGsfHTpiSqfIPUZ95bzK5-oMIu8S_TUcu-w,40
-matlab_proxy-0.25.1.dist-info/RECORD,,
+matlab_proxy-0.27.0.dist-info/METADATA,sha256=80E3g1CABuNM_zS6w8lhzJ8IbkfzvM1Nny7pui82kO4,11323
+matlab_proxy-0.27.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+matlab_proxy-0.27.0.dist-info/entry_points.txt,sha256=3wztwXpt6wdGfTwscc4qHbCeWzi0E2XhyJbMDndyQKc,304
+matlab_proxy-0.27.0.dist-info/licenses/LICENSE.md,sha256=oF0h3UdSF-rlUiMGYwi086ZHqelzz7yOOk9HFDv9ELo,2344
+matlab_proxy-0.27.0.dist-info/RECORD,,

{matlab_proxy-0.25.1.dist-info → matlab_proxy-0.27.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.2)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

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_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.
+
+---