https://github.com/delb-xml/cff-from-621
Derive a CITATION.cff from a pyproject.toml file's contents.
https://github.com/delb-xml/cff-from-621
citation-file-format metadata research-software-engineering
Last synced: 5 months ago
JSON representation
Derive a CITATION.cff from a pyproject.toml file's contents.
- Host: GitHub
- URL: https://github.com/delb-xml/cff-from-621
- Owner: delb-xml
- Created: 2022-09-18T21:09:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-01T13:12:59.000Z (6 months ago)
- Last Synced: 2026-01-06T14:30:12.552Z (5 months ago)
- Topics: citation-file-format, metadata, research-software-engineering
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cff-from-621
This tool derives a [`CITATION.cff`](https://citation-file-format.github.io/)
file from a Python project's `pyproject.toml` contents that provide
[PEP-621](https://peps.python.org/pep-0621/) compliant package metadata.
## Features
- Additional and overriding values can be provided statically or via Python
string templates.
- Order of the resulting fields can be defined, has a non-arbitrary default.
- Dynamic fields are resolved for the `setuptools` build backend.
## Example
Given a `pyproject.toml` that includes these contents:
```toml
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"
[project]
name = "cff-from-621"
description = "Generates metadata in the Citation File Format for Python projects from their PEP-621 compliant package definition. Includes a CLI."
keywords = ["PEP-621", "CFF", "conversion"]
authors = [
{name = "Frank Sachsenheim"}
]
dynamic = ["version"]
[tool.cff-from-621]
order = ["message", "cff-version", "title", "abstract", "version", "date-released", "authors", "keywords"]
[tool.cff-from-621.static]
date-released = "2022-09-18"
message = "🔥🌍🔥"
[tool.setuptools.dynamic]
version = {attr = "cff_from_621.version.VERSION"}
```
`cff-from-621` would derive this `CITATION.cff`:
```yaml
---
message: 🔥🌍🔥
cff-version: 1.2.0
title: cff-from-621
abstract: Generates metadata in the Citation File Format for Python projects from
their PEP-621 compliant package definition. Includes a CLI.
version: 0.0.1
date-released: '2022-09-18'
authors:
- name: Frank Sachsenheim
keywords:
- PEP-621
- CFF
- conversion
type: software
...
```
## Installation
Add `cff-from-621` with your environment management or install it globally
with [pipx](https://pypa.github.io/pipx/):
$ pipx install cff-from-621
## Usage
Change into your project's root folder and jump right in with:
$ cff-from-621
The usage details can be explored with:
$ cff-from-621 --help
### Caveats
1. Authors / maintainers are represented as [entity type](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsentity)
because their PEP-621 representation can't be parsed into the atomicity of the
[person type](https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsperson).
## Development
This tool isn't supposed to cover each and every corner case that may exist.
Its implementation shall be kept simple and may be used as library for custom
extensions and alterations.
All contributions within that frame are welcome.
In a virtual environment that you set up for development, install this package
from source in editable mode and required development tools:
$ pip install .[development]
Make use of or refer to the accompanying [`justfile`](https://just.systems/) to
run common development tasks.