argopy.utils.GreenCoding.shieldsio_endpoint

argopy.utils.GreenCoding.shieldsio_endpoint#

static GreenCoding.shieldsio_endpoint(value: float, outfile: Path | None = None, label: str = 'Total carbon emitted [gCO2eq]') → Path[source]#

Insert value in a Shields.io json endpoint file

This is used by the argopy monitoring repository.

See live results at:

euroargodev/argopy-status

Parameters:

  • value (float) – The carbon footprint value

  • outfile (pathlib.Path, default: None) – Path toward json file

  • label (str, default: 'Total carbon emitted [gCO2eq]') – The badge label to use

Return type:

pathlib.Path

Contents