citation#
- scikitplot.config.citation(which='all')[source]#
Return a BibTeX citation of scikit-plots.
- Parameters:
- which{“all”, “build”}, default=”all”
"all"cites every version (the concept DOI, which resolves to the latest release); it is__bibtex__."build"cites the installed build: its version and kind, the build version with its commit, and the URL of that exact source tree.
- Returns:
- str
One
@softwareentry.
- Raises:
- TypeError
If
whichis not a str.- ValueError
If
whichis not"all"or"build".- RuntimeError
If the installed build records an invalid version, commit or date.
See also
__bibtex__The entry for every version.
Notes
User notes. Cite
which="build"when results must be reproducible: a notebook can record exactly what it ran. A build made without git has no commit, so its entry has no year or month and itsurlis the repository. A release gets its own Zenodo DOI only when it was known when the package was built. Nothing is read from the network.Developer notes. The fields come from
tools/citation/citation_ref.py(fields, embedded at build time) and the build facts fromscikitplot.version, imported only whenwhich="build". The entry is the onecitation_ref.py render --commit <git_revision> --date <date>writes for that version.Examples
>>> from scikitplot.config import citation >>> citation() == citation("all") True >>> citation("build").startswith("@software{scikit-plots_v") True