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

ability to run howfairis in a local git repository #361

Open benvanwerkhoven opened 2 years ago

benvanwerkhoven commented 2 years ago

I think it would be nice for developers to run howfairis in a local git repository. This would enable developers to run howfairis on branches of the code that are not the default branch. It would also simplify the use of howfairis inside GitHub action workflows.

If I understand correctly, the check "has_open_repository" is the only one that really needs the GitHub/Gitlab URL and even that could be extracted from local files using 'git remote -v' for example.

This is of course just a suggestion. I know that a lot of code within howfairis is dedicated to fetching things from remote github or gitlab repositories, so this change may have a lot of impact on the code, I'm not sure. For as far as I know, it should be possible to perform most checks using local files though. What do you think of this idea? I'd be happy to help out.