cff2pages
This package should create a generic page based on your cff.
Science Score: 67.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
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 (13.5%) to scientific vocabulary
Repository
This package should create a generic page based on your cff.
Basic Info
- Host: GitHub
- Owner: University-of-Potsdam-MM
- License: mit
- Language: HTML
- Default Branch: main
- Homepage: https://university-of-potsdam-mm.github.io/cff2pages/
- Size: 122 KB
Statistics
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 8
- Releases: 6
Metadata Files
README.md
cff2pages
Motivation
The Citation.cff is a fantastic format that combines human-readable and machine-readable metadata about its repository. It provides linking systems with important metadata about the presented project and gives people the ability to reference the project, among other things. However, for a wide range of users, the YAML file format can seem intimidating, whereas a clean website is generally more readable. This project aims to automate the conversion of cff files, so that maintaining the cff file pays off for developers in terms of the project's presentation, thereby ensuring that the website representation is retained.
Project Description
cff2pages is envisioned as a Python package, designed to automate the extraction of metadata from your project's Citation.cff file, and swiftly generate a sleek, static HTML page. This versatile page can serve as a vivid representation of your project on Github/Gitlab Pages.
Usage
``` usage: cff2pages [-h] [-i [INPUT]] [-o [OUTPUT]]
Converts citation information in Citation File Format into HTML or Markdown
options: -h, --help show this help message and exit -i [INPUT], --input [INPUT] path to the input CFF file. Default: ./CITATION.cff -o [OUTPUT], --output [OUTPUT] path to the output file. Default: public/citation.html ```
Example
bash
cd project_folder
pip install cff2pages
cff2pages
By default, output will be written to public/citation.html.
Gitlab CI Runner
````yaml stages: - Pages
pages: stage: Pages image: python:3.11 script: - python -m pip install cff2pages - cff2pages -o public/index.html artifacts: paths: - public ````
Github Workflow
yaml
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python 3.11
uses: actions/setup-python@v3
with:
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install cff2pages
cff2pages -o public/index.html
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './public'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
Owner
- Name: University-of-Potsdam-MM
- Login: University-of-Potsdam-MM
- Kind: organization
- Repositories: 52
- Profile: https://github.com/University-of-Potsdam-MM
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: "cff2pages: Generate Markup from Your Citation.cff File"
version: 0.2.1
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Jan
family-names: Bernoth
email: jan.bernoth@uni-potsdam.de
affiliation: University of Potsdam
orcid: 'https://orcid.org/0000-0002-4127-0053'
- given-names: Toby
family-names: Hodges
affiliation: The Carpentries
orcid: 'https://orcid.org/0000-0003-1766-456X'
repository-code: 'https://github.com/University-of-Potsdam-MM/cff2pages'
identifiers:
- description: The archive of this project in Software Heritage. All persistent versions are accessible via this directory.
type: swh
value: "swh:1:dir:1e3e28077c43ca999f434f29b6a872f5581b48e2"
- description: Zenodo DOI to the repository
type: doi
value: "10.5281/zenodo.8213986"
abstract: >-
This repository generates HTML pages or Markdown sites for GitHub and GitLab based on your Citation.cff file.
This ensures that your CFF is optimized for both machine processing and human readability.
keywords:
- cff
- documentation
- pages
license: MIT
references:
- authors:
- family-names: Bernoth
given-names: Jan
orcid: https://orcid.org/0000-0002-4127-0053
- family-names: Hodges
given-names: Toby
orcid: https://orcid.org/0000-0003-1766-456X
title: "cff2pages: Generate Markup from Your Citation.cff File"
doi: 10.5281/zenodo.15638585
type: conference-paper
year: 2025
- authors:
- family-names: Bernoth
given-names: Jan
orcid: https://orcid.org/0000-0002-4127-0053
title: "cff2pages: Generate a frontend from your metadata"
doi: 10.5281/zenodo.10726204
type: conference-paper
year: 2024
- 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: Olexandr
orcid: https://orcid.org/0000-0001-5299-3292
title: Citation File Format
version: 1.2.0
doi: 10.5281/zenodo.1003149
type: software
- authors:
- family-names: Pavel
given-names: Antonia
- family-names: Garijo
given-names: Daniel
orcid: https://orcid.org/0000-0003-0454-7145
title: "Ya2RO: A tool for creating Research Object from minimum metadata"
type: article
year: 2023
doi: 10.4126/FRL01-006444984
GitHub Events
Total
- Create event: 4
- Release event: 1
- Issues event: 3
- Issue comment event: 1
- Push event: 24
- Pull request review event: 1
- Pull request review comment event: 1
- Pull request event: 7
- Fork event: 1
Last Year
- Create event: 4
- Release event: 1
- Issues event: 3
- Issue comment event: 1
- Push event: 24
- Pull request review event: 1
- Pull request review comment event: 1
- Pull request event: 7
- Fork event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 24 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 7
- Total maintainers: 1
pypi.org: cff2pages
This repository generates HTML pages or Markdown sites for GitHub and GitLab based on your Citation.cff file. This ensures that your CFF is optimized for both machine processing and human readability.
- Homepage: https://github.com/University-of-Potsdam-MM/cff2pages
- Documentation: https://github.com/University-of-Potsdam-MM/cff2pages
- License: MIT
-
Latest release: 0.2.1
published 9 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/configure-pages v3 composite
- actions/deploy-pages v2 composite
- actions/setup-python v3 composite
- actions/upload-pages-artifact v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v3 composite
- Jinja2 >=3.1.2
- cffconvert >=2.0.0
- Jinja2 *
- cffconvert *