Pyglet-gui is an extension of Pyglet for graphical user interfaces (GUIs). Thanks for checking it out.

This project started as a fork of Kytten, but ended up being a new project by its own right since the API changed dramatically.

This project is in pre-alpha.

• Implements a controller-viewer pattern.

  Pyglet-gui uses the concept of "controllers" to handle window events and "viewers" to draw.

  We provide both low-level interfaces such as two-state controllers, and end-user interfaces such as buttons, both of which designed to be extended to the user's need.

  For example, a Button is a subclass of a two-state controller and a viewer.

• Use of Mixins

  Pyglet-gui uses mixins for extending functionality of viewers and controllers. This increases code reusability and modularity.

  For example, you add mouse hovering behaviour to a button by mixin a Button with a HoveringMixin.

• Implements an abstraction for graphical appearance

  Pyglet-gui uses the concept of "theme", on which each (static) resource is defined in a JSON file. This file is loaded into a Theme, and viewers can load specific resources by choosing the particular resource they want by a unique path.

  For example, the Pyglet-gui standard Button chooses the path

    def get_path(self):
        path = ['button']
        if self.is_pressed():
            path.append('down')
        else:
            path.append('up')
        return path
  

  and the Theme binds a vertex list and a texture to the OpenGL from the specifications in the JSON file.

• Ships concrete implementations of some user interfaces:

  Pyglet-gui already contains some user interfaces implemented, such as:

  • Button, Slider
  • Option selector, Dropdown
  • Vertical, Horizontal, Grid containers.
  • Scrollable content display

1. Get a copy of the source from GitHub.

2. python setup.py install

The documentation is incomplete.

The documentation can be found in the read the docs.

You can run Pyglet-gui test suite from the root using

python -m tests.runtests

If you just want to run a specific module, you can use

python -m tests.specificModule

The contributor of Kytten was Conrad "Lynx" Wong, which this project reuses.

Jorge C. Leitão designed, unit tested and documented the API.