NASA-AMMOS / aerie-cli

An unofficial CLI for interacting with Aerie planning software
MIT License
3 stars 4 forks source link

Audit use/structure of data classes #60

Open cartermak opened 1 year ago

cartermak commented 1 year ago

Inspired by the goal of cleaning up the data classes as much as possible (see #11 and #32), we should audit everywhere they're used, everywhere they aren't but should, and how they're structured.

I'm particularly interested in codifying the difference between the "API" and "client" data classes. My current ideas are:

cartermak commented 1 year ago

Further thought: we have cases where we want to get either "metadata" (using the term loosely, not literal metadata in Aerie) or the full set of data. For example, we want to be able to either get high-level info about a plan (name, start/end times) or download a full plan. A way to do this in dataclasses would be to have a base class, e.g., AcitivtyPlanSummary, and a full version that inherits, e.g., ActivityPlan(ActivityPlanSummary).