cff2pages 0.3.0

This repository generates HTML pages or Markdown sites for GitHub and GitLab based on your Citation.cff or codemeta.json file. This ensures that your CFF is optimized for both machine processing and human readability.

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 or codemeta 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 or Codemeta.json metadata files and swiftly generate a sleek, static HTML page. This versatile page can serve as a vivid representation of your project on Github/Gitlab Pages.

Supported Metadata Formats

cff2pages currently supports the following metadata formats:

• Citation File Format (CFF) – CITATION.cff
• CodeMeta – codemeta.json

If both files exist in a repository, you can explicitly select one using the -i option.

Usage

usage: cff2pages [-h] [-i [INPUT]] [-o [OUTPUT]]

Converts citation information in Citation or Codemeta 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 ./codemeta.json
  -o [OUTPUT], --output [OUTPUT]
                        path to the output file. Default: public/citation.html
  -cb, --no-citation-box
                        Disable citation box. 

Example

cd project_folder
pip install cff2pages
cff2pages

By default, output will be written to public/citation.html.

Gitlab CI Runner

stages:
  - Pages

pages:
  stage: Pages
  image: python:3.12
  script:
    - python -m pip install cff2pages
    - cff2pages -o public/index.html
  artifacts:
    paths:
      - public

Github Workflow

  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.12
        uses: actions/setup-python@v3
        with:
          python-version: 3.12
      - 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