TraitsUI Documentation¶

TraitsUI: Traits-capable windowing framework¶

https://travis-ci.org/enthought/traitsui.svg?branch=master

https://ci.appveyor.com/api/projects/status/n2qy8kcwh8ibi9g3/branch/master?svg=true

https://codecov.io/github/enthought/traitsui/coverage.svg?branch=master

The TraitsUI project contains a toolkit-independent GUI abstraction layer, which is used to support the “visualization” features of the Traits package. Thus, you can write model in terms of the Traits API and specify a GUI in terms of the primitives supplied by TraitsUI (views, items, editors, etc.), and let TraitsUI and your selected toolkit and back-end take care of the details of displaying them.

Example¶

Given a Traits model like the following:

from traits.api import HasTraits, Str, Range, Enum

class Person(HasTraits):
    name = Str('Jane Doe')
    age = Range(low=0)
    gender = Enum('female', 'male')

person = Person(age=30)

we can use TraitsUI to specify a and display a GUI view:

from traitsui.api import Item, RangeEditor, View

person_view = View(
    Item('name'),
    Item('gender'),
    Item('age', editor=RangeEditor(mode='spinner')),
    buttons=['OK', 'Cancel'],
    resizable=True,
)

person.configure_traits(view=person_view)

which creates a GUI which looks like this:

https://raw.github.com/enthought/traitsui/master/README_example.png

Important Links¶

Website and Documentation: http://docs.enthought.com/traitsui
- User Manual http://docs.enthought.com/traitsui/traitsui_user_maunal
- Tutorial http://docs.enthought.com/traitsui/tutorial
- API Documentation http://docs.enthought.com/traitsui/api
Source code repository: https://github.com/enthought/traitsui
- Issue tracker: https://github.com/enthought/traitsui/issues
Download releases: https://pypi.python.org/pypi/traitsui
Mailing list: https://groups.google.com/forum/#!forum/ets-users

Installation¶

If you want to run traitsui, you must also install:

Traits https://github.com/enthought/traits
Pyface https://github.com/enthought/pyface

You will also need one of the following backends:

PyQt
wxPython
PySide
PyQt5

Backends have additional dependencies and there are optional dependencies on NumPy and Pandas for some editors.

TraitsUI along with all dependencies can be installed in a straightforward way using the Enthought Deployment Manager, pip or other .

Running the Test Suite¶

To run the test suite, you will need to install Git and EDM as well as have a Python environment which has install Click available. You can then follow the instructions in etstool.py. In particular: