Skip to main content

Automatically download Monaco editor assets.

Project description

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

python3 -m pip install monaco-assets
# or
uv pip install monaco-assets

Quick Start

import monaco_assets
server = monaco_assets.MonacoServer(port=8000)

Now, you can use http://localhost:8000/min/vs/loader.js in a webbrowser to see, e.g., loader.js. Please note that there are no directory listings, one has to directly address the file(s).

Cache Management

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.

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.5.1 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 file for details.

Monaco Editor is licensed under the MIT License by Microsoft Corporation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monaco_assets-0.5.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

monaco_assets-0.5.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file monaco_assets-0.5.1.tar.gz.

File metadata

  • Download URL: monaco_assets-0.5.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.11

File hashes

Hashes for monaco_assets-0.5.1.tar.gz
Algorithm Hash digest
SHA256 52e7b19b00c6f1c2e20818f1ca47719de0d6a0b48b0a3395ac054f19d828ff5e
MD5 460b280cb07bc6e0daa5a063046d9ac3
BLAKE2b-256 9524e01637c1a641d30d63bf1f823bded53eb428815810028b6a51b7ec680049

See more details on using hashes here.

File details

Details for the file monaco_assets-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for monaco_assets-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 46d4849fa64ee2b7377ec8f5ac14e435871e950fe7ba8a6312efb48bf48d2708
MD5 7e3ec6099db7feb980847072bf370382
BLAKE2b-256 8304c3d18fb0d2ca3b95319e20079c7ded29e2accc45a28eca5a3043078bec6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page