Installation

To install fairtally, do:

pip3 install --user fairtally

Usage

To use fairtally to check the compliance of multiple repositories, one can use the command below.

fairtally https://github.com/fair-software/fairtally https://github.com/fair-software/howfairis

This command will generate a html report called tally.html which will contain the results of the checks for each repository.

Then open the analysis in a web-browser, for example Firefox:

firefox tally.html

The report will look similar to the example below:

You can sort the table by clicking on the table headers. The purple plus signs provide access to log messages of each repository.

Checking many repositories will quickly exceed the rate limit of the APIs of GitLab and GitHub and resulting in all remaining repositories to be fully non-compliantly. See howfairis docs how setup environment variables to increase the rate limit.

Using Docker image

You can run fairtally Docker image using the command below.

docker pull fairsoftware/fairtally

You can run fairtally Docker image using the command below.

docker run --rm fairsoftware/fairtally --help

–rm argument will remove Docker container after execution.

To tally 2 URLs and save the report as tally.html in the current working directory you can run the command below.

docker run --rm fairsoftware/fairtally -o - https://github.com/fair-software/fairtally https://github.com/fair-software/howfairis > tally.html

See developer documentation to learn how to modify the Docker image.

curl https://research-software.nl/api/software > software.json

cat software.json | jq -r '[.[].repositoryURLs.github] | flatten | .[]' > urls.txt

fairtally --output-file report.html --input-file urls.txt

fairtally --help

Usage: fairtally [OPTIONS] [URLS]...

Options:
  -o, --output-file TEXT     Filename of where to write the results. Use `-`
                             to write to standard out.  [default: tally.html]

  -i, --input-file FILENAME  Check URLs in file. One URL per line. Use `-` to
                             read from standard input.

  --format [html|json]       Format of output.  [default: html]
  --version                  Show the version and exit.
  --help                     Show this message and exit.