ucl-cssb / MIMIC

Modelling and Inference of MICrobiomes Project (MIMIC) is a Python package dedicated to simulate, model, and predict microbial communities interactions

MIT License

5 stars 0 forks source link

Packaging #57

Closed Fontanapink closed 4 months ago

Fontanapink commented 4 months ago

Pull Request To-Do List

Description of the changes:

This PR mainly prepares the repository for ccollaborative workflow. In this PR: 1) There is a revamped Github action that:

Does type checking
automatically updates the requirements.txt
automatically formats mimic code's to pep8
runs all tests 2) Added type hinting to ALL the code of the project so that it is more user-friendly, document-rich producing, and helps with errors, etc. 3) clean-up of unused classes

I have done the following to make this PR ready for review:

[x] I have updated the requirements.txt file (if appropriate)
[x] I have re-based my branch on the latest master branch
[x] I have added necessary documentation (if appropriate)
[x] I have commented my code, particularly in hard-to-understand areas

For the reviewer, make sure this PR meets these criteria before merging:

[x] New code has comments
[x] New code has tests (if appropriate)
[x] New code has documentation (if appropriate)
[x] New code has been reviewed by at least one other person