Skip to main content

build GUIs from python types

Project description

magicgui

magicgui is released under the MIT license. magicgui on PyPI magicgui on conda-forge magicgui python version support

magicgui build status magicgui code coverage cite magicgui

build GUIs from type annotations, using magic.

📖 Docs

https://pyapp-kit.github.io/magicgui/

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!

See contributing guide here.

Project details


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.10.0.tar.gz (20.9 MB view details)

Uploaded Source

Built Distribution

magicgui-0.10.0-py3-none-any.whl (126.8 kB view details)

Uploaded Python 3

File details

Details for the file magicgui-0.10.0.tar.gz.

File metadata

  • Download URL: magicgui-0.10.0.tar.gz
  • Upload date:
  • Size: 20.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for magicgui-0.10.0.tar.gz
Algorithm Hash digest
SHA256 56dbe28afc526809e09932cd6caad8fc1a8305fe66c8feca16f797a04b5aee7c
MD5 d066e50763cff9c31eaa556545241986
BLAKE2b-256 ce44405f7028b00d94e29ddbaff00f2674e548d3bff8d343fbf7500bd77aa071

See more details on using hashes here.

Provenance

The following attestation bundles were made for magicgui-0.10.0.tar.gz:

Publisher: test_and_deploy.yml on pyapp-kit/magicgui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file magicgui-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: magicgui-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 126.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for magicgui-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 836276d61b0d9752eb8a215ff9f140c9c07ed5659b6e2a3c78df1cc96399aecd
MD5 27d71ade9ad059e337bfabb6b731e6f3
BLAKE2b-256 b6427e4f03201dfc10b4a8d4d94d183c878d7d0d4f2eee173e95294c71828014

See more details on using hashes here.

Provenance

The following attestation bundles were made for magicgui-0.10.0-py3-none-any.whl:

Publisher: test_and_deploy.yml on pyapp-kit/magicgui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page