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

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

Open
matentzn opened this issue Jul 19, 2022 · 8 comments
Assignees

Comments

@matentzn
Copy link
Collaborator

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

@matentzn
Copy link
Collaborator Author

Adopt the project layout from pheval:

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

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

image

@anitacaron
Copy link
Collaborator

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

@matentzn matentzn changed the title Consider cookie cutter for generating basic layout Adopt a standard layout for the repository that includes standard CI and api best practices Mar 13, 2023
@matentzn
Copy link
Collaborator Author

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
Copy link
Collaborator

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

@matentzn
Copy link
Collaborator Author

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
Copy link
Collaborator

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

@anitacaron
Copy link
Collaborator

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
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants