fsleyes-props

fsleyes-props is a library which allows you to:

  • Listen for change to attributes on a python object,

  • Automatically generate wxpython widgets which are bound to attributes of a python object

  • Automatically generate a command line interface to set values of the attributes of a python object.

To do this, you just need to subclass the HasProperties class, and add some PropertyBase types as class attributes.

The fsleyes-props package uses python descriptors to implement an event programming framework. It also includes the ability for automatic CLI generation and, optionally, automatic GUI generation (if wxPython is present).

The more important parts of this documentation are as follows:

  • The fsleyes_props package, for a quick overview.

  • The properties_types module for details of available property types.

  • The build module for details on GUI specification and generation.

  • The cli module for details on CLI specification and generation.

  • The widgets module for creating widgets linked to properties.

  • The bindable and syncable modules for details on binding properties between instances, and building hierarchical relationships between instances.

  • The properties and properties_value modules for details on how fsleyes-props works.