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

Uploaded Source

Built Distribution

magicgui-0.10.1-py3-none-any.whl (128.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for magicgui-0.10.1.tar.gz
Algorithm Hash digest
SHA256 422cd0c0b5fea2fb37f3d3ea9b5591a160919baeae16061efea6f74c9b8fcfd1
MD5 167fdb3ca81d0e0fb4b4d5f58ce6af93
BLAKE2b-256 bd48bd38d129c3899af725eeb2ecc03c5f32f174f79ac3c3d8babcb0642a08a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for magicgui-0.10.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: magicgui-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 128.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for magicgui-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15766d26c0d006d4211223abac5124493f50b5dd41798011e39cc0ebee66ae70
MD5 04d0a0c2b5d1492fa061cb1dc8477b25
BLAKE2b-256 fb846110f7d32d5b5a84d86ed00caf9cb6556745aeef9c8fa69d515958735dbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for magicgui-0.10.1-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