Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.43 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.43 KB
Raw

pyodide-cli

PyPI Latest Release GHA codecov

The command line interface for the Pyodide project.

In most cases, you do not need to install this package directly, and it would be installed as a dependency of other packages in the ecosystem (e.g. pyodide-build).

Installation

pip install pyodide-cli

Usage

To get a list of available CLI commands,

pyodide --help

Developers

You can register a subcommand in the pyodide CLI in your own package by:

  1. adding a dependency on pyodide-cli

  2. Adding a pyodide.cli entry point. For example, with

    setup.cfg

    [options.entry_points]
pyodide.cli =
 do_something = "<your-package>.cli:main"

    or

    pyproject.toml

    [project.entry-points."pyodide.cli"]
do_something = "<your-package>.cli:main"

    where in this example main needs to be a function with type annotations that can be converted to a CLI with typer.

License

pyodide-cli uses the Mozilla Public License Version 2.0.