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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for magicgui-0.10.0rc1.tar.gz
Algorithm Hash digest
SHA256 b536ca1c9582a9d9b1c581ee7a5d6eb49fa37c520a9c1c257f9af92bcc43235f
MD5 7719125246fc8892d0f77e7c9f0d522e
BLAKE2b-256 ab0518ef22ae1aade0c65916c62a2d49b0e4b26045524c2aa30cb61ff78f395d

See more details on using hashes here.

Provenance

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

Publisher: test_and_deploy.yml on pyapp-kit/magicgui

Attestations:

File details

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

File metadata

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

File hashes

Hashes for magicgui-0.10.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 40a2223c13db2dcbd782ba9bcd44edf2d73c8b9cdf5b8a48b6d9f709ab502011
MD5 13fabaf47cf61167200145b0667effd7
BLAKE2b-256 991100826c57a48321180b123163b2ef77d0d2bc3fe67888e0bf32bfd8e98c6f

See more details on using hashes here.

Provenance

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

Publisher: test_and_deploy.yml on pyapp-kit/magicgui

Attestations:

Supported by

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