Metadata-Version: 2.1
Name: pymmcore-widgets
Version: 0.2.1
Summary: A set of Qt-based widgets onto the pymmcore-plus model
Author-email: Federico Gasparoli <federico.gasparoli@gmail.com>, Talley Lambert <talley.lambert@gmail.com>, Ian Hunt-Isaak <ianhuntisaak@gmail.com>
License: BSD 3-Clause License
Project-URL: homepage, https://github.com/pymmcore-plus/pymmcore-widgets
Project-URL: repository, https://github.com/pymmcore-plus/pymmcore-widgets
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pymmcore-plus (>=0.6.3)
Requires-Dist: useq-schema (>=0.1.2)
Requires-Dist: superqt (>=0.3.1)
Requires-Dist: fonticon-materialdesignicons6
Requires-Dist: qtpy
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: cruft ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: ipython ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pdbpp ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: rich ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: vispy ; extra == 'docs'
Requires-Dist: mkdocs ; extra == 'docs'
Requires-Dist: mkdocs-material ; extra == 'docs'
Requires-Dist: mkdocstrings-python ; extra == 'docs'
Requires-Dist: mkdocs-literate-nav ; extra == 'docs'
Requires-Dist: mkdocs-gen-files ; extra == 'docs'
Provides-Extra: image
Requires-Dist: vispy ; extra == 'image'
Provides-Extra: pyqt5
Requires-Dist: PyQt5 ; extra == 'pyqt5'
Provides-Extra: pyqt6
Requires-Dist: PyQt6 ; extra == 'pyqt6'
Provides-Extra: pyside2
Requires-Dist: PySide2 ; extra == 'pyside2'
Provides-Extra: pyside6
Requires-Dist: PySide6 ; extra == 'pyside6'
Provides-Extra: test
Requires-Dist: pytest (>=6.0) ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-qt ; extra == 'test'

# pymmcore-widgets

[![License](https://img.shields.io/pypi/l/pymmcore-widgets.svg?color=green)](https://github.com/pymmcore-plus/pymmcore-widgets/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/pymmcore-widgets.svg?color=green)](https://pypi.org/project/pymmcore-widgets)
[![Python Version](https://img.shields.io/pypi/pyversions/pymmcore-widgets.svg?color=green)](https://python.org)
[![CI](https://github.com/pymmcore-plus/pymmcore-widgets/actions/workflows/ci.yml/badge.svg)](https://github.com/pymmcore-plus/pymmcore-widgets/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/pymmcore-plus/pymmcore-widgets/branch/main/graph/badge.svg)](https://codecov.io/gh/pymmcore-plus/pymmcore-widgets)

A set of widgets for the [pymmcore-plus](https://github.com/pymmcore-plus/pymmcore-plus) package.
This package can be used to build custom user interfaces for micromanager in a python/Qt environment.

[Documentation](https://pymmcore-plus.github.io/pymmcore-widgets)

## Usage

```python
from pymmcore_plus import CMMCorePlus
from pymmcore_widgets import StageWidget  # as an example... see below
from qtpy.QtWidgets import QApplication

mmcore = CMMCorePlus.instance()
mmcore.loadSystemConfiguration()

if __name__ == '__main__':
    app = QApplication([])
    stage = StageWidget('XY')
    stage.show()
    app.exec_()
```

![Screen Shot 2022-08-01 at 2 18 12 PM](https://user-images.githubusercontent.com/1609449/182217639-7f52a217-16f6-416a-a54f-2db63b7165c5.png)


See complete list of available widgets in the [documentation](https://pymmcore-plus.github.io/pymmcore-widgets/#widgets)


## Installation

```sh
pip install pymmcore-widgets

# note that this package does NOT include a Qt backend
# you must install one yourself, for example:
pip install PyQt5

# package is tested against PyQt5, PyQt6, PySide2, and PySide6
```
