The Selfie-Cam is to be used as an application program by the OBC. As such, the PAYLOAD team must provide an Application Programming Interface (API) so the OBC knows how to interact with the PAYLOAD program.
From RedHat: "APIS are sometimes thought of as contracts, with documentation that represents an agreement between parties: If party 1 sends a remote request structured a particular way, this is how party 2’s software will respond."
Next Steps 🚶
[ ] create a software design document that outlines:
[ ] classes
[ ] private class variables
[ ] public class variables
[ ] private methods
[ ] public methods
[ ] data structures
[ ] design patterns
[ ] software architecture
[ ] packages and imports
[ ] python package setup
[ ] justification for all the above
[ ] determine the required repository layout for a python package
[ ] implement software design document into software
[ ] use documentation for all method docstrings
[ ] use documentation to create a README.MD
[ ] write tests for all methods in software
[ ] revise and edit documentation and software to be reflective of one another
Motivation ⛰️
The Selfie-Cam is to be used as an application program by the OBC. As such, the PAYLOAD team must provide an Application Programming Interface (API) so the OBC knows how to interact with the PAYLOAD program.
From RedHat: "APIS are sometimes thought of as contracts, with documentation that represents an agreement between parties: If party 1 sends a remote request structured a particular way, this is how party 2’s software will respond."
Next Steps 🚶
Supporting Material and Resources 📖
Definition of Done 💯
Tags
cc: @matthewuhthoff @SeanTedesco @emmapaczkowski