pepkit / pephubclient

A tool to provide Python and CLI interface and Python API for PEPhub.
https://pephub.databio.org
BSD 2-Clause "Simplified" License
3 stars 0 forks source link

Added the skeleton for Views and Samples functions #35

Closed khoroshevskyi closed 9 months ago

khoroshevskyi commented 9 months ago

The purpose of this pull request is to review the API for samples and views endpoints, intended for use in bedboss and pipestat. Currently, it is only a skeleton without functionality. Before proceeding with the implementation of actual functionality, I would like to hear your opinion.

Example how it should work:

phc = PEPHubClient()

phc.view.get(...)

phc.sample.update(...)

@donaldcampbelljr I would like to hear also your opinion about it, because in the future you can use it for pephub backend implementation in pipestat

nsheff commented 9 months ago

you said phc.view.get(...)

but there is no .view anywhere... there is Views -- is that what you mean? I don't quite follow, can you add some documentation to explain this further? (ideally in the code itself, rather than in the PR comments)

khoroshevskyi commented 9 months ago

@nsheff ok, I will add docstring! For clarity: I am calling PEPHubClient().view, because I added property, that will return initialized class Views. User won't even see this class. I did it for modularity, so it will be easier to maintain code

donaldcampbelljr commented 9 months ago

Just some thoughts/questions as I read this PR...

Regarding future implementation with Pipestat:

khoroshevskyi commented 9 months ago

This PR is outdated