Document the data model (what data is passed where by whom and when) about rainbow-mind-machine

[charlesreid1]

Focus on common tasks (relates to clarifying who stores what):

• I want to set up my keys. What do I do?

  • Create a Keymaker
  • Run the Keymaker
  • Outcome is folder full of JSON files

• I want to do something with my bot flock

  • run Shepherd, which is the flock entry point
  • Shepherd will check bot keys
  • for each bot key, create a new bot Sheep
  • perform an action en masse

[charlesreid1]

This relates to the clarifying point we made in #10:

The Keymaker is (or rather, the items the Keymaker uses are) essential for the Sheep to have unique parameter values.

The Shepherd is just an old man who yells the same **kwargs at every Sheep and doesn't accept any input parameters.

The Sheep will combine the parameters in their JSON key with the input parameters from the Shepherd into self.params

[charlesreid1]

Related: #20 (boilerplate mind machine)

boilerplate makes it simpler to see how each layer stacks up

also makes it easier to visualize the flow of object oriented programming

[charlesreid1]

kwargs all the way down