Skip to main content

build GUIs from functions, using magic

Project description

icon

License Version conda-forge Python Version Build Status codecov

magicgui: build GUIs from functions, using magic.

📖 Docs

Installation

magicgui uses qtpy to support both pyside2 and pyqt5 backends. However, you must have one of those installed for magicgui to work.

install with pip

pip install magicgui[pyqt5]
# or
pip install magicgui[pyside2]

or with conda:

conda install -c conda-forge magicgui pyqt  # or pyside2 instead of pyqt

:information_source: If you'd like to help us extend support to a different backend, please open an issue.

Basic usage

from magicgui import magicgui
from enum import Enum

class Medium(Enum):
    Glass = 1.520
    Oil = 1.515
    Water = 1.333
    Air = 1.0003

# decorate your function with the @magicgui decorator
@magicgui(call_button="calculate", result_widget=True)
def snells_law(aoi=30.0, n1=Medium.Glass, n2=Medium.Water, degrees=True):
    import math

    aoi = math.radians(aoi) if degrees else aoi
    try:
        result = math.asin(n1.value * math.sin(aoi) / n2.value)
        return math.degrees(result) if degrees else result
    except ValueError:
        return "Total internal reflection!"

# your function is now capable of showing a GUI
snells_law.show(run=True)

snells

But that's just the beginning! Please see Documentation for many more details and usage examples.

Contributing

Contributions are welcome!

Please note: magicgui attempts to adhere to strict coding rules and employs the following static analysis tools to prevent errors from being introduced into the codebase:

To prevent continuous integration failures when contributing, please consider installing pre-commit in your environment to run all of these checks prior to checking in new code.

pre-commit install

Changelog

0.5.1 (2022-06-14)

Full Changelog

Fixed bugs:

  • Emit signal only if value of caterogical widget changed #422 (Czaki)

v0.5.0 (2022-06-13)

Full Changelog

Implemented enhancements:

  • feat: add request_values convenience, shows modal dialog to request values #416 (tlambert03)
  • Change to use adaptive step is SpinBox and FloatSpinBox #403 (Czaki)
  • Make call_button public #391 (dstansby)
  • Add scrollable widgets #388 (dstansby)

Fixed bugs:

Tests & CI:

Merged pull requests:

v0.4.0 (2022-03-25)

Full Changelog

Documentation:

v0.4.0rc1 (2022-03-18)

Full Changelog

Implemented enhancements:

Fixed bugs:

Deprecated:

  • Remove event deprecations strategy (for release 0.4.0) #368 (tlambert03)

Tests & CI:

  • Check out napari repo instead of git+https #378 (jni)
  • Test that bound values don't get called greedily upon widget creation #371 (tlambert03)

v0.3.7 (2022-02-12)

Full Changelog

Merged pull requests:

v0.3.6 (2022-02-11)

Full Changelog

Fixed bugs:

  • Fix _normalize_slot private attr access, and fix annotation setter forward ref resolution #367 (tlambert03)

v0.3.5 (2022-02-07)

Full Changelog

Implemented enhancements:

  • Create return matcher for extensible return widget creation #355 (gselzer)

Fixed bugs:

  • Add new type normalization TypeWrapper, fix builtin and optional ForwardRefs #362 (tlambert03)
  • Fix changing choices on ComboBox #352 (tlambert03)

Tests & CI:

Documentation:

Merged pull requests:

v0.3.4 (2022-01-01)

Full Changelog

Implemented enhancements:

Fixed bugs:

Tests & CI:

Documentation:

  • adds waveform generator exemple #322 (glyg)
  • add example of adding mpl FigureCanvas to widget #321 (tlambert03)

v0.3.3 (2021-11-08)

Full Changelog

Implemented enhancements:

Fixed bugs:

v0.3.2 (2021-10-22)

Full Changelog

Fixed bugs:

v0.3.1 (2021-10-21)

Full Changelog

Implemented enhancements:

  • Add stacklevel to provide better information about place of problem #302 (Czaki)
  • Table widget updates #301 (hanjinliu)

v0.3.0 (2021-10-10)

Full Changelog

Implemented enhancements:

  • Return type from register_type, so that it can be used as a decorator #297 (tlambert03)

Deprecated:

Documentation:

v0.3.0rc2 (2021-10-10)

Full Changelog

Fixed bugs:

  • Allow Signal.sender() to work regardless of importing from magicgui or Psygnal #296 (tlambert03)
  • Catch kwargs in event emitter (backwards compatibility with old event emitter) #295 (tlambert03)

v0.3.0rc1 (2021-10-04)

Full Changelog

Implemented enhancements:

  • Use psygnal instead of EventEmitter (callbacks receive value directly). Add deprecation strategy #253 (tlambert03)

Fixed bugs:

Tests & CI:

Merged pull requests:

v0.2.11 (2021-09-11)

Full Changelog

Implemented enhancements:

Fixed bugs:

  • Fix call button text and and param options when using decorator on class method #276 (tlambert03)
  • Fix check for Optional Type #270 (tlambert03)
  • Change comparison to null_value in ValueWidget from == to is #267 (tlambert03)
  • Fix missing event emission when nullable widget is set to null value. #263 (tlambert03)
  • Fix optional annotation affecting later widgets #262 (tlambert03)
  • Fix RangeWidget with implicit optional type #257 (tlambert03)

Tests & CI:

Documentation:

Merged pull requests:

v0.2.10 (2021-07-11)

Full Changelog

Implemented enhancements:

  • Add tracking property to sliders. When False, changed only emits on release. #248 (tlambert03)
  • Add ValueWidget._nullable, and enable for categorical widgets #227 (tlambert03)

Fixed bugs:

Documentation:

Merged pull requests:

v0.2.9 (2021-04-05)

Full Changelog

Implemented enhancements:

Fixed bugs:

Documentation:

Merged pull requests:

v0.2.8 (2021-03-24)

Full Changelog

v0.2.8rc0 (2021-03-24)

Full Changelog

Implemented enhancements:

  • Update call button to default True when auto_call is False #194 (jni)
  • add RadioButtons widget #183 (tlambert03)

Fixed bugs:

Documentation:

Merged pull requests:

v0.2.7 (2021-02-28)

Full Changelog

Implemented enhancements:

Fixed bugs:

Documentation:

Merged pull requests:

v0.2.6rc0 (2021-01-25)

Full Changelog

v0.2.6 (2021-01-25)

Full Changelog

Merged pull requests:

v0.2.5 (2021-01-13)

Full Changelog

Merged pull requests:

v0.2.4 (2021-01-12)

Full Changelog

Merged pull requests:

  • Extend combobox api with set_choice, get_choice, del_choice #92 (tlambert03)

v0.2.3 (2021-01-08)

Full Changelog

Merged pull requests:

v0.2.2 (2021-01-02)

Full Changelog

Merged pull requests:

v0.2.1 (2020-12-29)

Full Changelog

Merged pull requests:

v0.2.0 (2020-12-26)

Full Changelog

Merged pull requests:

v0.1.6 (2020-07-23)

Full Changelog

v0.1.6rc0 (2020-07-23)

Full Changelog

Merged pull requests:

v0.1.5 (2020-05-24)

Full Changelog

Merged pull requests:

v0.1.4 (2020-05-19)

Full Changelog

Merged pull requests:

v0.1.3 (2020-05-04)

Full Changelog

Merged pull requests:

v0.1.2 (2020-03-06)

Full Changelog

Merged pull requests:

v0.1.1 (2020-02-19)

Full Changelog

Merged pull requests:

v0.1.0 (2020-02-18)

Full Changelog

Merged pull requests:

v0.0.8 (2020-02-11)

Full Changelog

v0.0.7 (2020-02-09)

Full Changelog

v0.0.6 (2020-02-09)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

magicgui-0.5.1.tar.gz (109.5 kB view hashes)

Uploaded source

Built Distribution

magicgui-0.5.1-py2.py3-none-any.whl (101.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page