Skip to content

Usage

Installation

poetry install

Command line

poetry run maturity-meter evaluate https://github.com/owner/repo \
  --doi 10.1000/example --biotools-id example

Web API

poetry run maturity-meter-serve

POST /evaluate with a JSON body returns the maturity result:

{"repository": "https://github.com/owner/repo", "dois": [], "biotools_id": null}

Only repository is required.

Library

from maturity_meter import EvaluationRequest, evaluate_maturity

result = evaluate_maturity(
    EvaluationRequest(repository="https://github.com/owner/repo")
)

Functions

  • Evaluate maturity of a repository: statistical calculation, data analysis, quantification (input: data reference; output: matrix).
  • Visualise maturity: input matrix; output plot.