https://github.com/hoechenberger/mne-python-stubs

Type stubs for MNE-Python
https://github.com/hoechenberger/mne-python-stubs

Last synced: about 1 month ago
JSON representation

Type stubs for MNE-Python

• Host: GitHub
• URL: https://github.com/hoechenberger/mne-python-stubs
• Owner: hoechenberger
• License: bsd-3-clause
• Created: 2023-11-24T23:17:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-04T12:29:58.000Z (8 months ago)
• Last Synced: 2024-10-16T05:42:06.786Z (3 months ago)
• Language: Python
• Size: 1.83 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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

```shell

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

```

## Development

Clone this repository and `cd` into it.

```shell

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](https://github.com/python/typeshed).