Loading packages

Only the Python standard library is available after importing Pyodide. To use other packages, you’ll need to load them using either:

  • pyodide.loadPackage for packages built with Pyodide, or

  • micropip.install for pure Python packages with wheels available on PyPi or from other URLs.

Note

micropip can also be used to load packages built in Pyodide (in which case it relies on pyodide.loadPackage).

If you use pyodide.loadPackagesFromImports Pyodide will automatically download all packages that the code snippet imports. This is particularly useful for making a repl since users might import unexpected packages. At present, loadPackagesFromImports will not download packages from PyPi, it will only download packages included in the Pyodide distribution.

Loading packages with pyodide.loadPackage

Packages included in the official Pyodide repository can be loaded using pyodide.loadPackage:

pyodide.loadPackage('numpy');

It is also possible to load packages from custom URLs:

pyodide.loadPackage('https://foo/bar/numpy.js');

The file name in the URL must be /<package-name>.js and there must be an accompanying .data file in the same directory.

When you request a package from the official repository, all of that package’s dependencies are also loaded. Dependency resolution is not yet implemented when loading packages from custom URLs.

In general, loading a package twice is not permitted. However, one can override a dependency by loading a custom URL with the same package name before loading the dependent package.

Multiple packages can also be loaded at the same time by passing a list to `loadPackage.

pyodide.loadPackage(['cycler', 'pytz']);

pyodide.loadPackage returns a Promise which resolves when all of the packages are finished loading:

async function main(){
  await loadPyodide({ 'indexURL' : '<some-url>' });
  await pyodide.loadPackage('matplotlib');
  // matplotlib is now available
}
main();

Micropip

Installing packages from PyPI

Pyodide supports installing pure Python wheels from PyPI with micropip. micropip.install() returns a Python Future <https://docs.python.org/3/library/asyncio-future.html>_ so you can await the future or otherwise use the Python future API to do work once the packages have finished loading:

pyodide.runPythonAsync(`
  import micropip
  await micropip.install('snowballstemmer')
  import snowballstemmer
  stemmer = snowballstemmer.stemmer('english')
  print(stemmer.stemWords('go goes going gone'.split()))
`);

Micropip implements file integrity validation by checking the hash of the downloaded wheel against pre-recorded hash digests from the PyPi JSON API.

Installing wheels from arbitrary URLs

Pure Python wheels can also be installed from any URL with micropip,

import micropip
micropip.install(
    'https://example.com/files/snowballstemmer-2.0.0-py2.py3-none-any.whl'
)

Micropip decides whether a file is a URL based on whether it ends in “.whl” or not. The wheel name in the URL must follow PEP 427 naming convention, which will be the case if the wheels is made using standard Python tools (pip wheel, setup.py bdist_wheel).

All required dependencies must have been previously installed with micropip or pyodide.loadPackage.

If the file is on a remote server, the server must set Cross-Origin Resource Sharing (CORS) headers to allow access. Otherwise, you can prepend a CORS proxy to the URL. Note however that using third-party CORS proxies has security implications, particularly since we are not able to check the file integrity, unlike with installs from PyPi.

Example

<html>
<head>
  <meta charset="utf-8">
</head>
<body>
  <script type="text/javascript" src="https://cdn.jsdelivr.net/pyodide/dev/full/pyodide.js"></script>
  <script type="text/javascript">
    async function main(){
      await loadPyodide({ indexURL : 'https://cdn.jsdelivr.net/pyodide/dev/full/' });
      await pyodide.runPythonAsync(`
        import micropip # runPythonAsync will load micropip automatically
        await micropip.install('snowballstemmer')
        import snowballstemmer
        stemmer = snowballstemmer.stemmer('english')
        print(stemmer.stemWords('go goes going gone'.split()))
      `);
    }
    main();
  </script>
</body>
</html>