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/ in a webbrowser to see all assets.

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.4.3 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.4.3.tar.gz (4.6 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.4.3-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monaco_assets-0.4.3.tar.gz
Algorithm Hash digest
SHA256 f3060173210cb3e5024d9b92eb13d17ec3000a0b89fdc0bf0b3a314fbca42d1e
MD5 72a65b6881ee5ad4ae448e6584df4f6f
BLAKE2b-256 bce5a160e93f00fe3923e6318ce8cfa3e07fa6ca783da35425cd49153bbca5ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for monaco_assets-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 977b297583f644749453d2dde8bdc61d5d3008d07bc9f1c46bacbdafd368a169
MD5 1da1cce104b886df537b62ceca1f91cb
BLAKE2b-256 7196699958db8e12ea6d35a3921a07512d022c258c125e687910897cae6f0428

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