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.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.4.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.4.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monaco_assets-0.4.1.tar.gz
Algorithm Hash digest
SHA256 8254234b2dbb0583f6ae2dbc4d2582663860edc317cc62e11bd3a6cbe4789080
MD5 eccf76b596738a96776e2adc44b7cb1c
BLAKE2b-256 7363b56f1f7a1d0854dd5c3c86bf094b332e58e30fa448dd115bd717045e2caf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for monaco_assets-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 198eb5699e3762f439eca1a0a14364ac72d6587fb19455b01c89654088f80abd
MD5 151d715021f65e3c2571313cafed9c9b
BLAKE2b-256 aa536c119c16ce68271155b2e85b6a483c1886c885c0ec14b4fde83f6c685529

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