CABLE-LSM / meorg_client

API Client for ModelEvaluation.org.
Apache License 2.0
0 stars 1 forks source link

Initial commit with some scaffolding. All dev from here on out will f… #12

Closed bschroeter closed 8 months ago

bschroeter commented 8 months ago

Here is the initial implementation/skeleton for the API.

This repo will follow the formal issue workflow from here on out.

bschroeter commented 8 months ago

I've added some suggestions for type hints.

Also, will we eventually handle the requests.Response object within the client rather than returning it explicitly? E.g. list_endpoints returning a list instead of dict | requests.Response.

So list_endpoints is just a helper function at this stage for initial development so I can keep an eye on which endpoints become available on ME.org. The whole returned Response object for this endpoint is quite convoluted so not much use to the user wholesale.

I will aim for this to be simplified later, likely returning the URL and expected parameters.