monaco-assets 0.3.0__tar.gz

monaco_assets-0.3.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: monaco-assets
+Version: 0.3.0
+Summary: Automatically download Monaco editor assets.
+Keywords: monaco,assets
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: certifi
+Requires-Dist: platformdirs
+
+# Monaco Editor Assets
+
+A Python package that provides easy access to Monaco Editor assets. Assets are
+automatically downloaded on first use, eliminating the need to bundle large
+files with the package. The assets can be served by a webserver on a custom port.
+
+## Installation
+
+```bash
+python3 -m pip install monaco-assets
+# or
+uv pip install monaco-assets
+```
+
+## Quick Start
+
+```python
+import monaco_assets
+
+import monaco_assets
+server = monaco_assets.MonacoServer(port=8000)
+```
+
+Now, you can use `http://localhost:8000/` in a webbrowser to see all assets.
+
+## Cache Management
+
+```python
+import monaco_assets
+
+# Clear cache to free space before uninstalling the package
+monaco_assets.clear_cache()
+```
+
+## Cache Locations
+
+Assets are cached in platform-appropriate directories using the `platformdirs` library
+
+## How It Works
+
+1. **First Use**: When `get_path()` is called for the first time, the package:
+   - Downloads Monaco Editor from npmjs.org
+   - Verifies the download integrity with SHA1 hash
+   - Extracts assets to the user cache directory
+   - Returns the path to the assets
+
+2. **Subsequent Uses**: The package checks the cache and returns the existing assets path
+   immediately.
+
+## Download Issues
+
+If asset download fails:
+
+1. Check internet connectivity
+2. Verify firewall settings allow access to registry.npmjs.org
+3. Check disk space in cache directory
+
+## Cache Issues
+
+Clear and re-download if corrupted.
+
+```python
+monaco_assets.clear_cache()
+assets_path = monaco_assets.get_path()
+```
+
+## Version Correspondence
+
+Version correspondence will be ensured after initial bugfixes.
+
+| Package Version | Monaco Editor Version |
+| --------------- | --------------------- |
+| 0.3.0           | 0.54.0                |
+
+## Requirements
+
+- Python 3.10+
+- Internet connection (only for initial asset download)
+- ~100MB disk space for Monaco Editor assets
+
+## License
+
+MIT License - see [LICENSE](license.txt) file for details.
+
+Monaco Editor is licensed under the MIT License by Microsoft Corporation.
+

monaco_assets-0.3.0/README.md

@@ -0,0 +1,85 @@
+# Monaco Editor Assets
+
+A Python package that provides easy access to Monaco Editor assets. Assets are
+automatically downloaded on first use, eliminating the need to bundle large
+files with the package. The assets can be served by a webserver on a custom port.
+
+## Installation
+
+```bash
+python3 -m pip install monaco-assets
+# or
+uv pip install monaco-assets
+```
+
+## Quick Start
+
+```python
+import monaco_assets
+
+import monaco_assets
+server = monaco_assets.MonacoServer(port=8000)
+```
+
+Now, you can use `http://localhost:8000/` in a webbrowser to see all assets.
+
+## Cache Management
+
+```python
+import monaco_assets
+
+# Clear cache to free space before uninstalling the package
+monaco_assets.clear_cache()
+```
+
+## Cache Locations
+
+Assets are cached in platform-appropriate directories using the `platformdirs` library
+
+## How It Works
+
+1. **First Use**: When `get_path()` is called for the first time, the package:
+   - Downloads Monaco Editor from npmjs.org
+   - Verifies the download integrity with SHA1 hash
+   - Extracts assets to the user cache directory
+   - Returns the path to the assets
+
+2. **Subsequent Uses**: The package checks the cache and returns the existing assets path
+   immediately.
+
+## Download Issues
+
+If asset download fails:
+
+1. Check internet connectivity
+2. Verify firewall settings allow access to registry.npmjs.org
+3. Check disk space in cache directory
+
+## Cache Issues
+
+Clear and re-download if corrupted.
+
+```python
+monaco_assets.clear_cache()
+assets_path = monaco_assets.get_path()
+```
+
+## Version Correspondence
+
+Version correspondence will be ensured after initial bugfixes.
+
+| Package Version | Monaco Editor Version |
+| --------------- | --------------------- |
+| 0.3.0           | 0.54.0                |
+
+## Requirements
+
+- Python 3.10+
+- Internet connection (only for initial asset download)
+- ~100MB disk space for Monaco Editor assets
+
+## License
+
+MIT License - see [LICENSE](license.txt) file for details.
+
+Monaco Editor is licensed under the MIT License by Microsoft Corporation.

monaco_assets-0.3.0/monaco_assets/__init__.py

@@ -0,0 +1,208 @@
+"""
+Provide Monaco editor assets.
+
+Download Monaco editor assets at first use. The assets are downloaded,
+extracted, and made available in a platform specific cache folder. To
+access the assets,a simple webserver can be used.
+"""
+
+import hashlib
+import http.server
+import inspect
+import logging
+import shutil
+import socketserver
+import ssl
+import tarfile
+import threading
+import urllib.request
+from functools import partial
+from pathlib import Path
+
+import certifi
+from platformdirs import user_cache_dir
+
+VERSION = "0.54.0"
+EXPECTED_SHA1 = "c0d6ebb46b83f1bef6f67f6aa471e38ba7ef8231"
+
+CACHE_DIR = Path(user_cache_dir("monaco-assets", "monaco-assets")) / f"monaco-editor-{VERSION}"
+
+
+class _MonacoRequestHandler(http.server.SimpleHTTPRequestHandler):
+    """Custom HTTP request handler can use logging."""
+
+    def __init__(self, *args, logger=None, **kwargs):
+        """Init with optional logger."""
+        self.logger = logger
+        super().__init__(*args, **kwargs)
+
+    def log_message(self, format, *args):  # noqa: A002
+        """Override log_message to use logger.debug."""
+        if self.logger:
+            self.logger.debug(format % args)
+        else:
+            super().log_message(format, *args)
+
+
+class MonacoServer:
+    """HTTP server to serve Monaco editor assets."""
+
+    def __init__(self, port: int = 8000):
+        """
+        Initialize and start Monaco Editor assets server.
+
+        Download assets if needed and start a local HTTP server in a
+        background thread. The assets will be available at:
+        http://localhost:<port>
+
+        Parameters
+        ----------
+        port : int
+            Port number for the HTTP server (default: 8000)
+        """
+        self.logger = logging.getLogger(f"{__name__}.MonacoServer")
+        self._port: int = port
+        self._httpd: socketserver.TCPServer | None
+        self._thread: threading.Thread | None = threading.Thread(
+            target=self._run_server, daemon=True
+        )
+        self.logger.info("starting Monaco webserver.")
+        self._thread.start()
+
+    def _run_server(self):
+        """Run the HTTP server in a background thread."""
+        handler = partial(_MonacoRequestHandler, directory=get_path(), logger=self.logger)
+        self._httpd = socketserver.TCPServer(("", self._port), handler)
+        self._httpd.serve_forever()
+
+    def stop(self) -> bool:
+        """
+        Stop the Monaco editor assets server.
+
+        Returns
+        -------
+        bool
+            True if server was stopped, False if no server was running.
+        """
+        self.logger.info("stopping Monaco webserver.")
+        if self._httpd is None:
+            self.logger.warning("no Monaco webserver was running!")
+            return False
+        self._httpd.shutdown()
+        self._httpd.server_close()
+        if self._thread is not None:
+            self._thread.join(timeout=5.0)
+        self._thread = None
+        self._httpd = None
+        self.logger.info("Monaco webserver stopped.")
+        return True
+
+    def is_running(self) -> bool:
+        """
+        Check if the Monaco Editor assets server is currently running.
+
+        Returns
+        -------
+        bool
+            True if server is running, False otherwise
+        """
+        return self._thread is not None and self._thread.is_alive() and self._httpd is not None
+
+
+def _download_file(url: str, filename: Path) -> None:
+    """
+    Download a file from a URL to the destination path.
+
+    Parameters
+    ----------
+    url : str
+        The URL.
+    filename : Path
+        The filename of the received file.
+
+    """
+    context = ssl.create_default_context(cafile=certifi.where())
+    with urllib.request.urlopen(url, context=context) as response:
+        with open(filename, "wb") as out_file:
+            shutil.copyfileobj(response, out_file)  # type: ignore
+
+
+def _verify_file_hash(filename: Path, expected_sha1: str) -> bool:
+    """
+    Verify the SHA1 hash of a file.
+
+    Parameters
+    ----------
+    filename : Path
+        The file to verify.
+    expected_sha1 : str
+        The expected SHA1 hash.
+
+    Returns
+    -------
+    bool
+        True if hash matches, False otherwise.
+    """
+    sha1_hash = hashlib.sha1()
+    with open(filename, "rb") as f:
+        for chunk in iter(lambda: f.read(4096), b""):
+            sha1_hash.update(chunk)
+    actual_sha1 = sha1_hash.hexdigest()
+    return actual_sha1 == expected_sha1
+
+
+def _extract_tgz(tgz: Path) -> None:
+    """
+    Extract a .tgz file to the same directory.
+
+    Parameters
+    ----------
+    tgz: Path
+        The tar.gz file.
+    """
+    dest = tgz.parent
+    with tarfile.open(tgz, "r:gz") as tar:
+        # delete the if clause for Python>=3.12
+        supports_filter = "filter" in inspect.signature(tar.extract).parameters
+        for member in tar.getmembers():
+            if supports_filter:
+                tar.extract(member, dest, filter="data")
+            else:
+                tar.extract(member, dest)
+
+
+def get_path() -> Path:
+    """
+    Download Monaco Editor assets if they do not exist.
+
+    Returns
+    -------
+    Path
+        The path to the assests.
+    """
+    package_dir = CACHE_DIR / "package"
+
+    if package_dir.exists() and any(package_dir.iterdir()):
+        return package_dir
+    try:
+        CACHE_DIR.mkdir(parents=True, exist_ok=True)
+        package = "monaco-editor"
+        tgz = f"{package}-{VERSION}.tgz"
+        url = f"https://registry.npmjs.org/{package}/-/{tgz}"
+        tgz_file = CACHE_DIR / tgz
+        _download_file(url, tgz_file)
+        if not _verify_file_hash(tgz_file, EXPECTED_SHA1):
+            raise ValueError(f"Hash verification failed for {tgz_file}")
+        _extract_tgz(tgz_file)
+        tgz_file.unlink()
+        return package_dir
+    except Exception as e:
+        if CACHE_DIR.exists():
+            shutil.rmtree(CACHE_DIR, ignore_errors=True)
+        raise RuntimeError(f"Failed to download Monaco Editor assets: {e}") from e
+
+
+def clear_cache() -> None:
+    """Clear Monaco Editor asset cache."""
+    if CACHE_DIR.exists():
+        shutil.rmtree(CACHE_DIR)

monaco_assets-0.3.0/pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+name = "monaco-assets"
+version = "0.3.0"
+description = "Automatically download Monaco editor assets."
+requires-python = ">=3.10"
+dependencies = ["certifi", "platformdirs"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+]
+readme = "README.md"
+license = "MIT"
+
+keywords = ["monaco", "assets"]
+
+[build-system]
+requires = ["flit_core >=3.6,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.ruff]
+line-length = 99
+
+[tool.ruff.lint]
+extend-select = [
+    'D',        # pydocstyle (docstring formatting)
+    'A',        # flake8 builtins (Python builtins being used as variables or parameters.)
+    'I',        # isort (sort imports)
+    'PLW0602',  # unassigned global variable
+    'W505',     # doc line too long
+    'E501',     # line too long
+    'UP',       # use most modern code allowed by lowest python version
+]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 100
+max-doc-length = 72
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.pyrefly]
+project-includes = ["monaco_assets"]
+
+[dependency-groups]
+dev = [
+    "build>=1.3.0",
+    "pyrefly>=0.39.4",
+    "ruff>=0.13.0",
+    "twine>=6.2.0",
+]