Type stubs for MNE-Python

These are type stubs for MNE-Python. They contain docstrings for a more convenient user experience when using static analysis tools like Pylance in VS Code.

Installation

pip install https://github.com/hoechenberger/mne-python-stubs/archive/refs/heads/main.zip

Development

Clone this repository and cd into it.

pip install ".[dev]"

Running python gen_type_stubs_mne.py re-generates the type stubs for inclusion in MNE-Python.

Running python gen_type_stubs_vscode.py re-generates the type stubs with special markup for VS Code users.

Notes

• The name of this repository is mne-python-stubs,
• the package name is types-mne, and
• the stubs will be deployed into a directory named mne-stubs inside the Python site-packages directory.

Except for the first point, this is consistent with typeshed.