Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.56 KB

README.md

File metadata and controls

50 lines (31 loc) · 1.56 KB

Gui Interfaces

Gui interfaces is a python package that provides with base GUI classes to be inherited in the GUI of the exercises in Robotics Academy.

How to use

In order to import the specific Gui interface follow the next pattern.

Being for general interfaces:

from gui_interfaces.general.{INTERFACE} import ...

where {INTERFACE} needs to be substitued by the interface name.

And for specific interfaces:

from gui_interfaces.specific.{EXERCISE}.{INTERFACE} import ...

where {EXERCISE} is the name of exercise being worked on and {INTERFACE} needs to be substitued by the interface name.

How to add interfaces

If the interface is only specific to one exercise add it as a specific interface, if not the add it to general. Also the naming scheme that needs to be followed when naming a new interface file is snake case or lower case with underlines.

For reference, please refer to the existing interfaces.

General Interfaces

  • Inside the general directory

Specific Interfaces

  • Create a directory named after the exercise name inside of the specific directory.

How to add to an exercise

  • Import each interface as stated in the How to use section.
  • Create your exercise GUI that inherits from the chosen GUI interface
  • Check in each interface what needs to be implemented.