Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Design and provide convenience wrapper for getting all submission data #9

Open
lognaturel opened this issue Sep 19, 2022 · 1 comment
Labels
enhancement New feature or request question Further information is requested

Comments

@lognaturel
Copy link
Member

lognaturel commented Sep 19, 2022

Currently client.submissions.get_table has an interface that closely matches the backend API and it returns a dictionary that matches the structure of the raw JSON.

Some high-level things to consider for the parameters:

  • make it easier to specify a date range to filter submissions by
  • make it easier to specify a list of review states to include
  • unify json and csv downloads -- they're not very different from a user perspective
  • pull media if a path to store it is specified
  • add the Submissions. prefix for repeats (see repeats example)

Ideally the result could use type information in some way. Some ideas we've discussed:

  • provide a companion endpoint to get types and document how to get that into pandas
  • return json['value']: that would be the naturally-expected json structure
  • return a normalized and typed pandas dataframe (downside: lib depends on pandas)
  • deserialize into dynamically generated classes (downside: complex, and is it really what people want?)
@lognaturel lognaturel added enhancement New feature or request question Further information is requested labels Sep 21, 2022
@lognaturel
Copy link
Member Author

@lindsay-stevens: Maybe there's a library that already works with OData.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant