search

mapping-commons / sssom-api

Apache License 2.0
7 stars 0 forks source link

Adopt a standard layout for the repository that includes standard CI and api best practices #4

Open matentzn opened 2 years ago

matentzn commented 2 years ago

https://github.com/tiangolo/full-stack-fastapi-postgresql

matentzn commented 1 year ago

Adopt the project layout from pheval:

https://github.com/monarch-initiative/pheval

Sooner rather than layer, in particular, adopt these files:

anitacaron commented 1 year ago

Is the proposed layout related to the cookie cutter? Can you change the title, please?

matentzn commented 1 year ago

They are related - I changed the title; the point is to make a sane, standard repo structure with sane code style checking and integration testing, and a reasonably standard modular structure according to fastapi best practice

anitacaron commented 1 year ago

I was thinking of creating a cookie cutter for reuse, but that is different.

matentzn commented 1 year ago

You can, if you like! But this is less of a priority here then adding standardising this specific repo. My suggestion would be to first create a perfect layout here, and then, once we are happy with all of its aspects, transform it into a cookie cutter for monarch fastapi development?

anitacaron commented 1 year ago

Yes, entirely not the scope of this issue now and not previously.

anitacaron commented 1 year ago

Looking into the LICENSE in the pheval repo, it's missing to replace this part:

Copyright [yyyy] [name of copyright owner]

What does it need to be in the SSSOM API repo?

matentzn commented 1 year ago

Can you ask this question in the #codestyle channel in monarch org on slack?