Skip to main content

Import hook for Pyodide

Project description

pyodide-importer

Pyodide + external file import support

Installation

Inside Pyodide:

import micropip
await micropip.install("pyodide-importer")

Basic Usage

from pyodide_importer import register_hook
register_hook("<Base URL where python scripts are in>")
import external_module

Example

import micropip
await micropip.install("pyodide-importer")
from pyodide_importer import register_hook
register_hook("https://raw.githubusercontent.com/ryanking13/pyodide-importer/main/test_modules/")

# https://raw.githubusercontent.com/ryanking13/pyodide-importer/main/test_modules/file_module.py
import file_module
file_module.hello()

# https://raw.githubusercontent.com/ryanking13/pyodide-importer/main/test_modules/regular_module/__init__.py
import regular_module
regular_module.hello()

Advanced Usage

Whitelisting modules to import

Whitelisting modules will prevent from generating redundant HTTP requests when looking for not existing modules.

register_hook(
    "<Base URL where python scripts are in>",
    modules=["module1", "module2"]
)

Changing path where modules will be downloaded

download_path option changes the path where modules will be downloaded inside the virtual file system, default is set to the current working directory.

register_hook(
    "<Base URL where python scripts are in>",
    download_path="/path/to/be/downloaded",
)

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

pyodide-importer-0.0.2.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

pyodide_importer-0.0.2-py2.py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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