Software Open Access
A Ruby library for manipulating CITATION.cff files.
This library provides a Ruby interface to manipulate CITATION.cff files. The primary entry points are the Model and File classes.
See the CITATION.cff documentation for more details.Quick start
cff = CFF::Model.new("Ruby CFF Library") cff.version = CFF::VERSION cff.date_released = Date.today cff.authors << CFF::Person.new("Robert", "Haines") cff.license = "Apache-2.0" cff.keywords << "ruby" << "credit" << "citation" cff.repository_artifact = "https://rubygems.org/gems/cff" CFF::File.write("CITATION.cff", cff)
Will produce a file that looks something like this:
cff-version: 1.0.3 message: If you use this software in your work, please cite it using the following metadata title: Ruby CFF Library version: 0.3.0 date-released: 2018-03-04 license: Apache-2.0 repository-artifact: https://rubygems.org/gems/cff authors: - family-names: Haines given-names: Robert keywords: - ruby - credit - citation
Until this library reaches version 1.0.0 the API may be subject to breaking changes. When version 1.0.0 is released, then the principles of semantic versioning will be applied.Licence
Apache 2.0. See LICENCE for details.