howfairis 0.4.0

Python package to analyze compliance with fair-software.eu recommendations

Python package to analyze a GitHub repository’s compliance with the fair-software.eu recommendations.

Install

# while the package has not been released on PyPI yet, install with
pip3 install --user git+https://github.com/fair-software/howfairis

Afterwards check that the install directory was added to the PATH environment variable. You should then be able to call the executable, like so:

howfairis https://github.com/owner/repo      # Linux | Mac
howfairis.exe https://github.com/owner/repo  # Windows

Expected output

Depending on for which repository you are doing the analysis, the output looks something like this:

Checking compliance with fair-software.eu...
Running for https://github.com/fair-software/badge-test

(1/5) repository
        has_open_repository: true
(2/5) license
        has_license: true
(3/5) registry
        has_pypi_badge: true
        has_conda_badge: false
        has_bintray_badge: false
        is_on_github_marketplace: false
(4/5) citation
        has_zenodo_badge: true
        has_citationcff_file: false
        has_citation_file: false
        has_zenodo_metadata_file: false
        has_codemeta_file: false
(5/5) checklist
        has_core_infrastructures_badge: true
        has_sonarcloud_badge: false

Calculated compliance: ● ● ● ● ●

Expected badge is equal to the actual badge. It's all good.

Development install

# Create a virtualenv, e.g. with
python3 -m virtualenv -p python3 venv3

# activate virtualenv
source venv3/bin/activate

# (from the project root directory)
# install howfairis as an editable package
pip install --editable .
pip install --editable .[dev]

Afterwards check that the install directory was added to the PATH environment variable. You should then be able to call the executable, like so:

howfairis https://github.com/owner/repo      # Linux | Mac
howfairis.exe https://github.com/owner/repo  # Windows

For maintainers

Bumping the version across all files is done with bump2version, e.g.

bump2version minor