Data

Tools

Indexes

Applications

Experiments

Open Source Science

cffreference

A simple CLI to extract citation information from a CITATION.cff.

https://github.com/kevinmatthes/cffreference

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.4%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

A simple CLI to extract citation information from a CITATION.cff.

Basic Info
  • Host: GitHub
  • Owner: kevinmatthes
  • License: gpl-2.0
  • Language: Rust
  • Default Branch: main
  • Size: 156 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 5
Created almost 4 years ago · Last pushed almost 4 years ago
Metadata Files
Readme Changelog License Citation

README.md

cffreference

Summary

A simple CLI to extract citation information from a CITATION.cff.

License

This project's license is GPL 2 (as of June 1991). The whole license text can be found in LICENSE in the main directory of this repository. The brief version is as follows:

Copyright (C) 2022 Kevin Matthes

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

When compiling a printable version of this documentation using Pandoc, the full license will be attached automatically to the resulting document. This can be invoked by calling repository-manual.m.

Software Requirements

| Requirement | Type | Role | |:------------------|:-------------:|:--------------------------------------| | docs-snippets | repository | documentation constants | | GHC | application | Haskell compiler | | GNU Octave | application | execution of the provided scripts | | Haddock | application | creation of source code documentation | | Pandoc | application | compilation of repository manual | | texlive-full | package | compilation of repository manual |

The compilation of such an optional repository manual can be invoked by just calling one of the following lines in a terminal.

octave repository-manual.m octave-cli repository-manual.m

Both will redirect to the same application, GNU Octave, which will then create the manual for this repository and attach the entire license to it. The resulting file, repository.pdf, will be saved in the main directory of this repository.

Description

A common task when working with CFF is adding another project's citation meta data to the own CITATION.cff's references section. Since these files are often very long -- due to having references to cite on their own or many people who contributed, for instance -- and not sorted uniformly, it might be a challenge to filter out all required lines by hand. Furthermore, there can also be a preferred-citation provided which could be overseen in a quite big citation configuration file.

In order to solve these issues, cffreference provides the capability to appropriately cite another project automatically. Given an input file which is valid according to the Schema Version 1.2.0, cffreference will extract the relevant lines to cite.

Any input file will be cited by its preferred-citation, by default. If this entry should not be specified, the whole file will be processed in order to generate a proper references item. In the latter case, the input file is assumed to specify a software.

By default, the results are written to stdout. This behaviour is intended to be a preview mode in order to verify that the correct repository is going to be cited. The extracted results can be also piped around in terminal sessions such that other CFF tools can be instructed with cffreference's output.

cffreference ./path/to/input/CITATION.cff

In order to append the extracted citation information to a certain, writable CITATION.cff, its path must be given as the second argument to the application which will then add the new reference at the end of the output file.

cffreference ./path/to/input/CITATION.cff ./path/to/output/CITATION.cff

In case no arguments or more than two are given, the application will show the license information as well as a brief information on how to use cffreference correctly.

cffreference <!----------------------------------------------------------------------------->

Owner

  • Name: Kevin Matthes
  • Login: kevinmatthes
  • Kind: user

Citation (CITATION.cff) 

######################## GNU General Public License 2.0 ########################
##                                                                            ##
## Copyright (C) 2022 Kevin Matthes                                           ##
##                                                                            ##
## This program is free software; you can redistribute it and/or modify       ##
## it under the terms of the GNU General Public License as published by       ##
## the Free Software Foundation; either version 2 of the License, or          ##
## (at your option) any later version.                                        ##
##                                                                            ##
## This program is distributed in the hope that it will be useful,            ##
## but WITHOUT ANY WARRANTY; without even the implied warranty of             ##
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              ##
## GNU General Public License for more details.                               ##
##                                                                            ##
## You should have received a copy of the GNU General Public License along    ##
## with this program; if not, write to the Free Software Foundation, Inc.,    ##
## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.                ##
##                                                                            ##
################################################################################

################################################################################
##
##  AUTHOR      Kevin Matthes
##  BRIEF       Citation settings for the Git repository.
##  COPYRIGHT   (C) 2022 Kevin Matthes.
##              This file is licensed GPL 2 as of June 1991.
##  DATE        2022
##  FILE        CITATION.cff
##  NOTE        See `LICENSE' for full license.
##              See `README.md' for project details.
##
################################################################################

# Parser settings.
cff-version: 1.2.0
message: Please cite this software using these meta data.

# Version information.
date-released: 2022-05-13
version: 0.5

# Project information.
abstract: A simple CLI to extract citation information from a CITATION.cff.
authors:
  - family-names: Matthes
    given-names: Kevin
license: GPL-2.0
repository-code: https://github.com/kevinmatthes/cffreference
title: cffreference
url: https://github.com/kevinmatthes/cffreference

# References.
references:
  - type: standard
    abstract: CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software. This is the specification for the Citation File Format.
    authors:
      - family-names: Druskat
        given-names: Stephan
        orcid: https://orcid.org/0000-0003-4925-7248
      - family-names: Spaaks
        given-names: Jurriaan H.
        orcid: https://orcid.org/0000-0002-7064-4069
      - family-names: Chue Hong
        given-names: Neil
        orcid: https://orcid.org/0000-0002-8876-7606
      - family-names: Haines
        given-names: Robert
        orcid: https://orcid.org/0000-0002-9538-7919
      - family-names: Baker
        given-names: James
        orcid: https://orcid.org/0000-0002-2682-6922
      - family-names: Bliven
        given-names: Spencer
        orcid: https://orcid.org/0000-0002-1200-1698
        email: spencer.bliven@gmail.com
      - family-names: Willighagen
        given-names: Egon
        orcid: https://orcid.org/0000-0001-7542-0286
      - family-names: Pérez-Suárez
        given-names: David
        orcid: https://orcid.org/0000-0003-0784-6909
        website: https://dpshelio.github.io
      - family-names: Konovalov
        given-names: Alexander
        orcid: https://orcid.org/0000-0001-5299-3292
    title: Citation File Format
    version: 1.2.0
    identifiers:
      - type: doi
        value: 10.5281/zenodo.1003149
        description: The concept DOI for the collection containing all versions of the Citation File Format.
      - type: doi
        value: 10.5281/zenodo.5171937
        description: The versioned DOI for the version 1.2.0 of the Citation File Format.
    date-released: "2021-08-09"
    keywords:
      - citation file format
      - CFF
      - citation files
      - software citation
      - file format
      - YAML
      - software sustainability
      - research software
      - credit
    license: "CC-BY-4.0"
    doi: 10.5281/zenodo.5171937
  - type: software
    abstract: Command line program to validate and convert CITATION.cff files.
    authors:
      - affiliation: Netherlands eScience Center
        family-names: Spaaks
        given-names: Jurriaan H.
        orcid: https://orcid.org/0000-0002-7064-4069
      - affiliation: Netherlands eScience Center
        family-names: Klaver
        given-names: Tom
      - affiliation: Netherlands eScience Center
        family-names: Verhoeven
        given-names: Stefan
        orcid: https://orcid.org/0000-0002-5821-2060
      - affiliation: Humboldt-Universität zu Berlin
        family-names: Druskat
        given-names: Stephan
        orcid: https://orcid.org/0000-0003-4925-7248
      - affiliation: University of Oslo
        family-names: Leoncio
        given-names: Waldir
        name-suffix: Netto
    date-released: 2021-09-22
    identifiers:
      - type: doi
        value: 10.5281/zenodo.1162057
        description: Persistent identifier for all versions of cffconvert
      - type: doi
        value: 10.5281/zenodo.5521767
        description: Persistent identifier for this version of cffconvert
      - type: url
        value: https://github.com/citation-file-format/cff-converter-python
        description: URL to the GitHub repository for cffconvert
      - type: url
        value: https://pypi.org/project/cffconvert
        description: cffconvert on PyPI
    keywords:
      - bibliography
      - BibTeX
      - cff
      - citation
      - CITATION.cff
      - CodeMeta
      - EndNote
      - RIS
      - Citation File Format
    license: Apache-2.0
    repository-artifact: https://pypi.org/project/cffconvert
    repository-code: https://github.com/citation-file-format/cff-converter-python
    title: cffconvert
    version: 2.0.0
  - type: software-code
    title: Ruby CFF Library
    abstract: This library provides a Ruby interface to manipulate Citation File Format files
    authors:
    - family-names: Haines
      given-names: Robert
      orcid: https://orcid.org/0000-0002-9538-7919
      affiliation: The University of Manchester, UK
    - name: The Ruby Citation File Format Developers
    keywords:
    - ruby
    - credit
    - software citation
    - research software
    - software sustainability
    - metadata
    - citation file format
    - CFF
    version: 0.9.0
    doi: 10.5281/zenodo.1184077
    date-released: 2021-08-18
    license: Apache-2.0
    repository-artifact: https://rubygems.org/gems/cff
    repository-code: https://github.com/citation-file-format/ruby-cff
  - type: manual
    title: "GNU Octave version 7.1.0 manual: a high-level interactive language for numerical computations"
    authors:
      - family-names: Eaton
        given-names: John W.
      - family-names: Bateman
        given-names: David
      - family-names: Hauberg
        given-names: "Søren"
      - family-names: Wehbring
        given-names: Rik
    year: 2022
    url: https://www.gnu.org/software/octave/doc/v7.1.0/
  - type: software-code
    date-released: 2022-05-11
    version: 0.0.3
    abstract: A collection of initialised source file templates.
    authors:
      - family-names: Matthes
        given-names: Kevin
    license: GPL-2.0
    repository-artifact: https://github.com/kevinmatthes/blank
    title: blank
    url: https://github.com/kevinmatthes/blank
  - type: software-code
    date-released: 2022-05-11
    version: 0.0.0
    abstract: A collection of common documentation configuration files.
    authors:
      - family-names: Matthes
        given-names: Kevin
    license: GPL-2.0
    repository-artifact: https://github.com/kevinmatthes/docs-snippets
    title: docs-snippets
    url: https://github.com/kevinmatthes/docs-snippets
  - type: software
    authors:
      -
        family-names: Spaaks
        given-names: "Jurriaan H."
        orcid: "https://orcid.org/0000-0002-7064-4069"
      -
        family-names: Diblen
        given-names: Faruk
        orcid: "https://orcid.org/0000-0002-0989-929X"
      -
        family-names: "Soares Siqueira"
        given-names: Abel
        orcid: "https://orcid.org/0000-0003-4451-281X"
    date-released: 2022-01-24
    identifiers:
      - type: doi
        value: 10.5281/zenodo.3993241
        description: "The work's conceptdoi"
    license: "Apache-2.0"
    title: "cffconvert GitHub Action"
    version: 2.0.0
  - type: software
    abstract: Parses the Git history.
    authors:
      - alias: wert007
        family-names: Hamacher
        given-names: Pablo
      - family-names: Matthes
        given-names: Kevin
    license: MIT
    repository-code: https://github.com/wert007/commit-analyzer
    title: commit-analyzer
    url: https://github.com/wert007/commit-analyzer
  - type: software
    date-released: 2022-05-01
    version: 0.2.0
    abstract: A very simple translator from Italian to some other languages.
    authors:
      - family-names: Matthes
        given-names: Kevin
      - family-names: Giovanardi
        given-names: Daniela
    license: GPL-2.0
    repository-code: https://github.com/kevinmatthes/italiano
    title: italiano
    url: https://github.com/kevinmatthes/italiano

################################################################################

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 167
  • Total Committers: 1
  • Avg Commits per committer: 167.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Kevin Matthes k****s@s****e 167
Committer Domains (Top 20 + Academic)
s2019.tu-chemnitz.de: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/cffconvert.yml actions
  • actions/checkout 2541b1294d2704b0964813337f33b291d3f8596b composite
  • citation-file-format/cffconvert-github-action 4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 composite
Cargo.lock cargo
  • getopts 0.2.21
  • unicode-width 0.1.9
Cargo.toml cargo