chore: update readme

* allow .cff extension for yaml files

Author: sgfost

README.md

@@ -1,4 +1,16 @@
-Currently, CodeMeta is used as a central "hub" representation of software metadata as it is the most exhaustive, and provides [crosswalk definitions](https://codemeta.github.io/crosswalk/) between other formats. This is done in order to avoid the need for a bridge between every format, though custom conversion logic can be implemented for any 'crosswalk'
+![](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fsgfost%2Fcodemeticulous%2Fmain%2Fpyproject.toml) ![](https://img.shields.io/github/license/sgfost/codemeticulous)
+
+> [!NOTE]
+> `codemeticulous` is in an early state of development and things are subject to change. Refer to the [table](#feature-roadmap) below to see currently supported formats and conversions.
+
+`codemeticulous` is a python library and command line utility for validating and converting between different metadata standards for software. Validation is done by providing [pydantic](https://docs.pydantic.dev/latest/) models that mirror the standards' schema definitions.
+
+Currently, CodeMeta is used as a central "hub" representation of software metadata as it is the most exhaustive, and provides [crosswalk definitions](https://codemeta.github.io/crosswalk/) between other formats. This is done in order to avoid the need for a bridge between every format, though custom conversion logic can be implemented where needed.
+
+> [!NOTE]
+> This is subject to change, however. There is an argument to be made for whether an even more robust internal data model would be beneficial. Namely, that going through CodeMeta/schema.org means some conversions will be lossy.
+
+## Feature Roadmap
 
 <table><thead>
   <tr>
@@ -9,14 +21,14 @@ Currently, CodeMeta is used as a central "hub" representation of software metada
   <tr>
     <td>Name<br></td>
     <td>Version(s)</td>
-    <td>Model</td>
+    <td>Pydantic Model</td>
     <td>from CodeMeta<br></td>
     <td>to CodeMeta<br></td>
   </tr>
   <tr>
     <td><a href="https://codemeta.github.io/">CodeMeta</a><br></td>
     <td><a href="https://w3id.org/codemeta/3.0"><code>v3</code></a></td>
-    <td>✅</td>
+    <td>✅ *</td>
     <td>-</td>
     <td>-</td>
   </tr>
@@ -57,3 +69,78 @@ Currently, CodeMeta is used as a central "hub" representation of software metada
   </tr>
 </tbody>
 </table>
+
+\* The `CodeMeta` model is currently implemented as a pydantic **v1** model, due to a heavy reliance on [pydantic_schemaorg](https://github.com/lexiq-legal/pydantic_schemaorg) which has not been fully updated.
+
+## Installation
+
+<!-- ```
+pip install codemeticulous
+```
+
+or install the latest development version -->
+
+```
+$ pip install git+https://github.com/sgfost/codemeticulous.git
+```
+
+## Usage
+
+### As a command line tool
+
+```
+$ codemeticulous convert --from codemeta --to cff codemeta.json > CITATION.cff
+$ codemeticulous validate --format cff CITATION.cff
+```
+
+### As a python library
+
+```python
+from codemeticulous.codemeta.models import CodeMeta, Person
+from codemeticulous.cff.convert import codemeta_to_cff
+
+codemeta = CodeMeta(
+  name="My Project",
+  author=Person(givenName="Dale", familyName="Earnhardt"),
+)
+
+cff = codemeta_to_cff(codemeta)
+
+print(codemeta.json(indent=True))
+# {
+#   "@context": "https://w3id.org/codemeta/3.0",
+#   "@type": "SoftwareSourceCode",
+#   "name": "My Project",
+#   "author": {"@type": "Person", "givenName": "Dale", "familyName": "Earnhardt"}
+# }
+
+print(cff.yaml())
+# authors:
+# - family-names: Earnhardt
+#   given-names: Dale
+# cff-version: 1.2.0
+# message: If you use this software, please cite it using the metadata from this file.
+# title: My Project
+# type: software
+```
+
+<!-- ### As a Github Action -->
+
+## Development
+
+`codemeticulous` uses [`uv`](https://docs.astral.sh/uv/) for project management. The following assumes that you have [installed uv](https://docs.astral.sh/uv/getting-started/installation/).
+
+Get started by cloning the repository and setting up a virtual environment
+
+```
+$ git clone https://github.com/sgfost/codemeticulous.git
+$ cd codemeticulous
+$ uv sync --dev
+$ source .venv/bin/activate
+```
+
+Run tests
+
+```
+$ uv run pytest tests
+```

codemeticulous/cff/convert.py

@@ -221,7 +221,7 @@ def codemeta_to_cff(data: CodeMeta) -> CitationFileFormat:
     primary_doi = extract_doi_from_codemeta_identifier(data.identifier)
     return CitationFileFormat(
         cff_version="1.2.0",
-        message="If you use this software, please cite it as below.",
+        message="If you use this software, please cite it using the metadata from this file.",
         abstract=data.description,
         authors=codemeta_actors_to_cff(data.author),
         date_released=(

codemeticulous/cli.py

@@ -142,11 +142,11 @@ def load_file_autodetect(file_path):
         with open(file_path, "r") as file:
             if ext in [".json"]:
                 return json.load(file)
-            elif ext in [".yaml", ".yml"]:
+            elif ext in [".yaml", ".yml", ".cff"]:
                 return yaml.safe_load(file)
             else:
                 raise ValueError(
-                    f"Unsupported file extension: {ext}. Expected .json or .yaml"
+                    f"Unsupported file extension: {ext}."
                 )
     except Exception as e:
         raise ValueError(f"Failed to load file: {file_path}. {str(e)}")