DOI 2 cff

https://travis-ci.org/citation-file-format/doi2cff.svg?branch=master Documentation Status SonarCloud quality gate SonarCloud coverage https://zenodo.org/badge/DOI/10.5281/zenodo.1206048.svg

Script to create citation file formatted file (https://citation-file-format.github.io/) from a DOI.

Current supported DOI types:

Free software: Apache Software License 2.0

Documentation: https://doi2cff.readthedocs.io.

Installation

Requires Python 3.5 or higher.

pip install git+https://github.com/citation-file-format/doi2cff

Usage

To create a CITATION.cff file of a release, you must supply the doi that is associated with the release.

doi2cff init <doi>

# For example for boatswain (https://github.com/NLeSC/boatswain)
doi2cff init https://doi.org/10.5281/zenodo.1149011

The generated file must be checked for correctness and you are encouraged to enrich it further.

Whenever a new release is made of the software the CITATION.cff must be updated with new doi/version/release date. This process can be automated by running

doi2cff update <doi>

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.