Data

Tools

Indexes

Applications

Experiments

Open Source Science

cff-reader-python

Python reader for Citation File Format

https://github.com/zedthree/cff-reader-python

Science Score: 44.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
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.6%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

Python reader for Citation File Format

Basic Info
  • Host: GitHub
  • Owner: ZedThree
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 23.4 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 3
  • Releases: 0
Created over 7 years ago · Last pushed over 7 years ago
Metadata Files
Readme License Citation

README.md

cff-reader-python

A python reader for the Citation File Format (cff). It can load cff files locally or from github repositories, and provides a class for citations.

Heavily based on https://github.com/citation-file-format/cff-converter-python

Getting started

Download the code and install using 

pip install --user .

in the download folder.

Use the code by importing into your own python file: python import cffreader

Usage examples

Read from a local CITATION.cff file: python citation = cffreader.reader(from_filename="CITATION.cff")

Read from a github repository (eg this one!): python citation = cffreader.reader(from_url="https://github.com/ZedThree/cff-reader-python")

Running the tests

Tests are written using pytest. Run pytest in the toplevel.

Acknowledgments

Some code from the cff-convertor-python project at https://github.com/citation-file-format/cff-converter-python/

Initial code developed at the cff-file-format hackday

Owner

  • Name: Peter Hill
  • Login: ZedThree
  • Kind: user

Research Software Engineer at University of York; EPSRC RSE Fellow

Citation (CITATION.cff) 

# This file is a citation metadata file in the Citation File Format
# (http://citation-file-format.github.io/).
# 
# It provides citation metadata for this version of cff-reader-python.

cff-version: 1.0.3
message: "If you use cff-reader-python in your work, please cite it using the following metadata"
title: cff-reader-python
authors:
  - family-names: Hill
    given-names: Peter Alec
    orcid:  https://orcid.org/0000-0003-3092-1858
  - family-names: Radtke
    given-names: Jennifer Carol Joan
    orcid: https://orcid.org/0000-0002-0641-9641
version: 0.1.0
date-released: 2018-09-05
references:
  - type: software
    authors:
     -
       affiliation: "Netherlands eScience Center"
       family-names: Spaaks
       given-names: Jurriaan H.
     -
       affiliation: "Netherlands eScience Center"
       family-names: Klaver
       given-names: Tom
     -
       affiliation: "Netherlands eScience Center"
       family-names: Verhoeven
       given-names: Stefan
     -
       affiliation: "Humboldt-Universität zu Berlin"
       family-names: Druskat
       given-names: Stephan
       orcid: https://orcid.org/0000-0003-4925-7248
    license: Apache-2.0
    date-released: 2018-07-25
    doi: 10.5281/zenodo.1162057
    repository-code: "https://github.com/citation-file-format/cff-converter-python"
    title: cffconvert
    version: "1.0.1"

GitHub Events

Total
Last Year

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 21
  • Total Committers: 3
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.19
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Peter Hill z****e@g****m 17
Jennifer C J Radtke j****e@d****k 2
RadtkeJCJ j****e@g****m 2
Committer Domains (Top 20 + Academic)
dunelm.org.uk: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 3
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • 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
  • ZedThree (3)
Pull Request Authors
  • RadtkeJCJ (2)
Top Labels
Issue Labels
enhancement (3)
Pull Request Labels

Dependencies

requirements.txt pypi
  • PyYAML ==3.12
  • click ==6.7
  • pykwalifire ==2.0.1
  • requests ==2.18.4
requirements-dev.txt pypi
  • pytest ==3.3.2 development
  • pytest-cov ==2.5.1 development
  • pytest-runner ==4.2 development