facile_rs.create_cff

Create a CFF citation file from a CodeMeta metadata file

Description

This script takes a CodeMeta metadata file as input and generates a CFF (Citation File Format) citation file. The CFF file contains information about the software, including its authors, contributors, and other metadata.

The script accepts command-line arguments to specify the locations of the CodeMeta metadata file, additional codemeta JSON files for creators and contributors and the path to the output CFF file.

Usage

usage: create_cff.py [-h] [--codemeta-location CODEMETA_LOCATION]
                     [--creators-locations CREATORS_LOCATIONS]
                     [--contributors-locations CONTRIBUTORS_LOCATIONS]
                     [--cff-path CFF_PATH] [--no-sort-authors]
                     [--log-level LOG_LEVEL] [--log-file LOG_FILE]

Named Arguments

--codemeta-location

Locations of the main codemeta.json JSON file

--creators-locations, --creators-location

Locations of codemeta JSON files for additional creators

Default: []

--contributors-locations, --contributors-location

Locations of codemeta JSON files for additional contributors

Default: []

--cff-path

Path to the cff output file

--no-sort-authors

Do not sort authors alphabetically, keep order in codemeta.json file

Default: True

--log-level

Log level (ERROR, WARN, INFO, or DEBUG)

--log-file

Path to the log file

Example usage

python3 create_cff.py \
    --codemeta-location /path/to/codemeta.json \
    --creators-location /path/to/creators.json \
    --cff-path /path/to/output.cff

Module Contents

Functions

create_parser
main
main_deprecated

API

create_parser(add_help=True)

main()

main_deprecated()