{"id":16042564,"url":"https://github.com/fair-software/howfairis","last_synced_at":"2026-04-02T02:08:21.176Z","repository":{"id":44631848,"uuid":"292858062","full_name":"fair-software/howfairis","owner":"fair-software","description":"Command line tool to analyze a GitHub or GitLab repository's compliance with the fair-software.eu recommendations","archived":false,"fork":false,"pushed_at":"2025-05-07T10:10:59.000Z","size":937,"stargazers_count":64,"open_issues_count":84,"forks_count":26,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-09-28T05:01:51.608Z","etag":null,"topics":["fair","fair-software","fair4rs","fairness","research-software"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/howfairis/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fair-software.png","metadata":{"files":{"readme":"README.dev.rst","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.rst","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-09-04T13:42:15.000Z","updated_at":"2025-07-10T16:23:39.000Z","dependencies_parsed_at":"2024-06-21T15:45:23.444Z","dependency_job_id":"110fa95c-853e-4286-813c-9aabc9fadda8","html_url":"https://github.com/fair-software/howfairis","commit_stats":{"total_commits":866,"total_committers":13,"mean_commits":66.61538461538461,"dds":"0.27020785219399535","last_synced_commit":"53144dab4d76466ae15de9372aae94bcc9cd81ae"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/fair-software/howfairis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fair-software%2Fhowfairis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fair-software%2Fhowfairis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fair-software%2Fhowfairis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fair-software%2Fhowfairis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fair-software","download_url":"https://codeload.github.com/fair-software/howfairis/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fair-software%2Fhowfairis/sbom","scorecard":{"id":391502,"data":{"date":"2025-08-11","repo":{"name":"github.com/fair-software/howfairis","commit":"f30207b84deef32935a5d0dabf1386a589c808d4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":2,"reason":"Found 1/5 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/cffconvert.yml:1","Warn: no topLevel permission defined: .github/workflows/dockertest.yml:1","Warn: no topLevel permission defined: .github/workflows/livetests.yml:1","Warn: no topLevel permission defined: .github/workflows/quality.yml:1","Warn: no topLevel permission defined: .github/workflows/tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"CII-Best-Practices","score":2,"reason":"badge detected: InProgress","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cffconvert.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/cffconvert.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/cffconvert.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/cffconvert.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dockertest.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/dockertest.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/livetests.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/livetests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/livetests.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/livetests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/quality.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/quality.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/quality.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/quality.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/quality.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/fair-software/howfairis/tests.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.13.2-alpine3.21 to python:3.13.2-alpine3.21@sha256:323a717dc4a010fee21e3f1aac738ee10bb485de4e7593ce242b36ee48d6b352","Warn: pipCommand not pinned by hash: Dockerfile:8-9","Warn: pipCommand not pinned by hash: Dockerfile:8-9","Warn: pipCommand not pinned by hash: .github/workflows/livetests.yml:28","Warn: pipCommand not pinned by hash: .github/workflows/livetests.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/quality.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/tests.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/tests.yml:33","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   7 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":9,"reason":"SAST tool is not run on all commits -- score normalized to 9","details":["Warn: 29 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T17:55:47.744Z","repository_id":44631848,"created_at":"2025-08-18T17:55:47.744Z","updated_at":"2025-08-18T17:55:47.744Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31294398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T01:43:37.129Z","status":"online","status_checked_at":"2026-04-02T02:00:08.535Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fair","fair-software","fair4rs","fairness","research-software"],"created_at":"2024-10-09T00:02:55.873Z","updated_at":"2026-04-02T02:08:21.147Z","avatar_url":"https://github.com/fair-software.png","language":"HTML","funding_links":[],"categories":["FAIR in general"],"sub_categories":[],"readme":"``howfairis`` developer documentation\n=====================================\n\nIf you're looking for user documentation, go `here \u003cREADME.rst\u003e`_.\n\n|\n|\n\nDevelopment install\n-------------------\n\n.. code:: shell\n\n    # Create a virtualenv, e.g. with\n    python3 -m venv venv3\n\n    # activate virtualenv\n    source venv3/bin/activate\n    \n    # make sure to have a recent version of pip, wheel, setuptools\n    python3 -m pip install --upgrade pip wheel setuptools\n\n    # (from the project root directory)\n    # install howfairis as an editable package, with development dependencies\n    python3 -m pip install --no-cache-dir --editable .[dev]\n\nAfterwards check that the install directory is present on the ``PATH``\nenvironment variable. If so, you should  be able to call the executable,\nlike so:\n\n.. code:: shell\n\n    howfairis https://github.com/\u003cowner\u003e/\u003crepo\u003e\n\nRunning the tests\n-----------------\n\nRunning the tests requires an activated virtualenv with the development tools installed.\n\n.. code:: shell\n\n    # unit tests with mocked representations of repository behavior\n    pytest\n    pytest tests/\n    \n    # live tests with actual repository behavior (slow, prone to HttpError too many requests)\n    pytest livetests/\n    \n    # command line interface tests\n    bash clitests/script.sh\n\nRunning linters locally\n-----------------------\n\nRunning the linters requires an activated virtualenv with the development tools installed.\n\n.. code:: shell\n\n    # linter\n    prospector\n\n    # recursively check import style for the howfairis module only\n    isort --check-only howfairis\n\n    # recursively check import style for the howfairis module only and show\n    # any proposed changes as a diff\n    isort --check-only --diff howfairis\n\n    # recursively fix  import style for the howfairis module only\n    isort howfairis\n\n.. code:: shell\n\n    # requires activated virtualenv with development tools\n    prospector \u0026\u0026 isort --check-only howfairis\n\nYou can enable automatic linting with ``prospector`` and ``isort`` on commit like so:\n\n.. code:: shell\n\n    git config --local core.hooksPath .githooks\n\nVersioning\n----------\n\nBumping the version across all files is done with bump2version, e.g.\n\n.. code:: shell\n\n    bump2version minor\n\n\nMaking a release\n----------------\n\nPreparation\n^^^^^^^^^^^\n\n1. Update the ``CHANGELOG.md``\n2. Verify that the information in ``CITATION.cff`` is correct\n3. Make sure the version has been updated.\n4. Run the unit tests with ``pytest tests/``\n5. Run the live tests with ``pytest livetests/``\n6. Run the clitests with ``bash clitests/script.sh``\n\nPyPI\n^^^^\n\nIn a new terminal, without an activated virtual environment or a venv3 directory:\n\n.. code:: shell\n\n    # prepare a new directory\n    cd $(mktemp -d --tmpdir howfairis.XXXXXX)\n    \n    # fresh git clone ensures the release has the state of origin/main branch\n    git clone https://github.com/fair-software/howfairis.git .\n    \n    # prepare a clean virtual environment and activate it\n    python3 -m venv venv3\n    source venv3/bin/activate\n    \n    # make sure to have a recent version of pip, wheel, setuptools\n    python3 -m pip install --upgrade pip wheel setuptools\n\n    # install runtime dependencies and publishing dependencies\n    python3 -m pip install --no-cache-dir .[publishing]\n    \n    # clean up any previously generated artefacts \n    rm -rf howfairis.egg-info\n    rm -rf dist\n    \n    # create the source distribution and the wheel\n    python3 setup.py sdist bdist_wheel\n\n    # upload to test pypi instance (requires credentials)\n    twine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\nIn a new terminal, without an activated virtual environment or a venv3 directory:\n\n.. code:: shell\n    \n    cd $(mktemp -d --tmpdir howfairis-test.XXXXXX)\n\n    # check you don't have an existing howfairis\n    which howfairis\n    python3 -m pip uninstall howfairis\n\n    # install in user space from test pypi instance:\n    python3 -m pip -v install --user --no-cache-dir \\\n    --index-url https://test.pypi.org/simple/ \\\n    --extra-index-url https://pypi.org/simple howfairis\n\nCheck that the package works as it should when installed from pypitest.\n\nThen upload to pypi.org with:\n\n.. code:: shell\n\n    # Back to the first terminal,\n    # FINAL STEP: upload to PyPI (requires credentials)\n    twine upload dist/*\n\nGitHub and Zenodo\n^^^^^^\n\n1. Make a release on GitHub\n2. Verify that making the GitHub release triggered Zenodo into making an archived snapshot of the release.\n\nDockerHub\n^^^^^^^^^\n\nTo build the image, run:\n\n.. code:: shell\n\n    docker build -t fairsoftware/howfairis:latest .\n    \n.. code:: shell\n\n    VERSION=$(howfairis --version | sed 's/version: //g')\n    docker tag fairsoftware/howfairis:latest fairsoftware/howfairis:${VERSION}\n\nCheck that you have the tags you want with:\n\n.. code:: shell\n\n    docker images\n\nTest the docker image with:\n\n.. code:: shell\n\n    docker run -ti --rm fairsoftware/howfairis:latest --help\n    docker run -ti --rm fairsoftware/howfairis:latest --version\n    docker run -ti --rm fairsoftware/howfairis:latest https://github.com/fair-software/howfairis-livetest\n    docker run -ti --rm fairsoftware/howfairis:latest https://gitlab.com/jspaaks/howfairis-livetest\n    \n    # check what's inside the docker container with\n    docker run -ti --rm --entrypoint /bin/sh fairsoftware/howfairis:latest\n\nTo push the image to DockerHub, run:\n\n.. code:: shell\n\n    # (requires credentials)  \n    docker login\n    docker push fairsoftware/howfairis:${VERSION}\n    docker push fairsoftware/howfairis:latest    \n    \n    # log out again to avoid uploading images from other projects\n    # later using credentials from this project\n    docker logout\n    \nThe new image and its tags should now be listed here https://hub.docker.com/r/fairsoftware/howfairis/tags?page=1\u0026ordering=last_updated.\n    \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffair-software%2Fhowfairis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffair-software%2Fhowfairis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffair-software%2Fhowfairis/lists"}