fair-software / howfairis

Command line tool to analyze a GitHub or GitLab repository's compliance with the fair-software.eu recommendations
https://pypi.org/project/howfairis/
Apache License 2.0
58 stars 23 forks source link

Does not work with repositories in Gitlab subgroups #328

Open caha42 opened 3 years ago

caha42 commented 3 years ago

I tried to run the check for the following repo: https://gitlab.com/hifis/hifis-workshops/make-your-code-ready-for-publication/astronaut-analysis I get the error it cannot find the README.

howfairis.exe https://gitlab.com/hifis/hifis-workshops/make-your-code-ready-for-publication/astronaut-analysis.git -b check-final-results Checking compliance with fair-software.eu... url: https://gitlab.com/hifis/hifis-workshops/make-your-code-ready-for-publication/astronaut-analysis.git branch: check-final-results Did not find a README[.md|.rst] file at https://gitlab.com/hifis/hifis-workshops/-/raw/check-final-results/ Proceeding without it -- expect the compliance to suffer.

Using the path command also did not help, since the wrong url is created in combination with the -b command.

howfairis.exe https://gitlab.com/hifis/hifis-workshops/make-your-code-ready-for-publication/ -b check-final-results -p make-your-code-ready-for-publication/astronaut-analysis Checking compliance with fair-software.eu... url: https://gitlab.com/hifis/hifis-workshops/make-your-code-ready-for-publication/ branch: check-final-results path: make-your-code-ready-for-publication/astronaut-analysis Did not find a README[.md|.rst] file at https://gitlab.com/hifis/hifis-workshops/-/raw/check-final-results/make-your-code-ready-for-publication/astronaut-analysis/ Proceeding without it -- expect the compliance to suffer.

The issue seems to be that the project is located in several subgroups. This is non-existant in Github, but quite common in Gitlab. It would be great if you can add support for this.

jspaaks commented 3 years ago

Hi Carina, thanks for reporting this. Indeed subgroups are not supported at the moment. We'll look into how to improve this in the future.