https://github.com/arfon/ruby-cff
A Ruby library for manipulating CITATION.cff files.
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.0%) to scientific vocabulary
Last synced: 10 months ago
·
JSON representation
Repository
A Ruby library for manipulating CITATION.cff files.
Basic Info
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Fork of paxos/ruby-cff
Created about 5 years ago
· Last pushed about 5 years ago
https://github.com/arfon/ruby-cff/blob/master/
# Ruby CFF
## Robert Haines
A Ruby library for manipulating CITATION.cff files.
[](https://doi.org/10.5281/zenodo.1184077)
[](https://badge.fury.io/rb/cff)
[](https://travis-ci.org/citation-file-format/ruby-cff)
[](https://codeclimate.com/github/citation-file-format/ruby-cff/maintainability)
[](https://coveralls.io/github/citation-file-format/ruby-cff)
### Synopsis
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](https://citation-file-format.github.io/) for more details.
### Quick start
```ruby
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:
```
# This CITATION.cff file was created by ruby-cff (v 0.5.0).
# Gem: https://rubygems.org/gems/cff
# CFF: https://citation-file-format.github.io/
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
```
### Library versions
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](https://semver.org/) will be applied.
### Licence
[Apache 2.0](http://www.apache.org/licenses/). See LICENCE for details.
Owner
- Name: Arfon Smith
- Login: arfon
- Kind: user
- Location: Edinburgh
- Website: arfon.org
- Twitter: arfon
- Repositories: 86
- Profile: https://github.com/arfon
Schmidt Sciences. Previously product @github, data science @spacetelescope, @zooniverse co-founder. Editor-in-chief of the Journal of Open Source Software