Welcome to Approximate Engineering’s Python Task Framework Documentation!

This library provides a lightweight task and resource framework designed to simplify the process of coding up a PiWars robot. It is written in for Python 3, tested on 3.7, and is available under the Apache License v2 on GitHub

The library also provides special support for generating menu systems for your robots through a simple YAML based definition format and an extensible menu task.

Installation

Install with pip, preferably into a virtual environment:

$ pip3 install approxeng.task

Contents

• Simple Usage
  • Defining Resources
    • Constant Resources
    • Variable Resources
    • Resource Dependencies
    • Advanced Resources
  • Defining Tasks
    • Simple Tasks
    • Simple Stateful Tasks and Task Counts
    • Switching Tasks
  • Pre-task Functions
• Menu Generation
  • Menu Definitions
    • Multiple Menus
    • More Concise Nested Menus
    • Returning a Value from a Menu
  • Implementing a MenuTask
  • Registering Menu Tasks
• API
• Change Log
  • Version 0.1