search

Sage-Bionetworks / sage-monorepo

Where OpenChallenges, Schematic, and other Sage open source apps are built
https://sage-bionetworks.github.io/sage-monorepo/
Apache License 2.0
21 stars 12 forks source link

Research spike: incorporating core synapse python client in monorepo #1981

Open thomasyu888 opened 10 months ago

thomasyu888 commented 10 months ago

What projects is this feature for?

No response

Description

What are the requirements to include: https://github.com/Sage-Bionetworks/spccore into the monorepo?

This will act as the core python functionality to interact with the synapse API

Anything else?

No response

Code of Conduct

tschaffter commented 10 months ago

@thomasyu888 Is the core python client used in the existing client or would that be the low-level code generated by OpenAPI Generator?

thomasyu888 commented 10 months ago

@tschaffter The core python client is currently not used in the existing client, but it will be when its created. The core python client should either be:

  1. Auto generated by openAPI generator - with tweaks to the jinja templates.
  2. Build off the existing repo: https://github.com/Sage-Bionetworks/spccore.
  3. Combination of 1 and 2

I believe the auto generated python models of request and response objects would be incredibly helpful, but I'm worried about the robustness of the auto generated package (HTTP requests, error catching, caching, async). That said, we might be better off developing the jinja template that can create a robust package.

tschaffter commented 10 months ago

@thomasyu888 Is this a task you wish to assign to the new hire who will be responsible for the development of the client?