feat: add somesy support

a.pirogov · a.pirogov · commit daf263c49f4f · 2023-07-21T14:38:02.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,29 +3,13 @@ exclude: "^{{ cookiecutter.*"  # <-- added
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-
-  # Various general + format-specific helpers
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-    - id: check-symlinks
-    - id: trailing-whitespace
-    - id: mixed-line-ending
-      args: [--fix=lf]
-    - id: check-yaml
-      exclude: 'mkdocs.yml'
-    - id: check-toml
-    - id: check-json
-    - id: check-ast
-    - id: debug-statements
-    - id: check-merge-conflict
-    - id: check-shebang-scripts-are-executable
-    - id: check-added-large-files
-      args: [--maxkb=10000]
+  # GH Actions
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: '0.22.0'
     hooks:
     - id: check-github-workflows
+
+  # General Python linters and formatters
   - repo: https://github.com/pycqa/isort
     rev: '5.12.0'
     hooks:
@@ -80,8 +64,27 @@ repos:
     hooks:
       - id: reuse
 
-  - repo: https://github.com/Materials-Data-Science-and-Informatics/dev-utils
-    rev: 'v0.1.0'
+  - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
+    rev: "e8bf980" # "0.1.0" TODO: set to tag once released
     hooks:
-      - id: update-codemeta
-        files: ^pyproject.toml$
+      - id: somesy
+
+  # Various general + format-specific helpers
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    - id: check-symlinks
+    - id: trailing-whitespace
+      exclude: 'CITATION.cff'
+    - id: mixed-line-ending
+      args: [--fix=lf]
+    - id: check-yaml
+      exclude: 'mkdocs.yml'
+    - id: check-toml
+    - id: check-json
+    - id: check-ast
+    - id: debug-statements
+    - id: check-merge-conflict
+    - id: check-shebang-scripts-are-executable
+    - id: check-added-large-files
+      args: [--maxkb=10000]
diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -7,7 +7,7 @@ Files: {{ cookiecutter*
 Copyright: 2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <s.sandfeld@fz-juelich.de>
 License: CC0-1.0
 
-Files: .gitignore pyproject.toml poetry.lock .pre-commit-config.yaml codemeta.json CITATION.cff README.md RELEASE_NOTES.md CHANGELOG.md CODE_OF_CONDUCT.md AUTHORS.md CONTRIBUTING.md .github/* mkdocs.yml docs/*
+Files: .gitignore pyproject.toml poetry.lock .pre-commit-config.yaml .somesy.toml codemeta.json CITATION.cff README.md RELEASE_NOTES.md CHANGELOG.md CODE_OF_CONDUCT.md AUTHORS.md CONTRIBUTING.md .github/* mkdocs.yml docs/*
 Copyright: 2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <s.sandfeld@fz-juelich.de>
 License: CC0-1.0
 
diff --git a/.somesy.toml b/.somesy.toml
@@ -0,0 +1,29 @@
+[project]
+name = "fair-python-cookiecutter"
+version = "0.1.1"
+description = "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
+
+license = "MIT"
+keywords = [
+    "fair",
+    "metadata",
+    "python",
+    "cookiecutter",
+    "template",
+]
+
+repository = "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
+homepage = "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter"
+documentation = "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter"
+
+[[project.people]]
+given-names = "Anton"
+family-names = "Pirogov"
+email = "a.pirogov@fz-juelich.de"
+orcid = "https://orcid.org/0000-0002-5077-7497"
+
+author = true
+maintainer = true
+
+[config]
+verbose = true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,11 @@ Here we provide notes that summarize the most important changes in each released
 
 Please consult the changelog to inform yourself about breaking changes and security issues.
 
+## [v0.1.1](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/tree/v0.1.0) <small>(2023-05-11)</small> { id="0.1.1" }
+
+* Add [somesy](https:///Materials-Data-Science-and-Informatics/somesy) to manage and synchronize project metadata
+* Various minor fixes
+
 ## [v0.1.0](https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter/tree/v0.1.0) <small>(2023-05-11)</small> { id="0.1.0" }
 
 * First release
diff --git a/CITATION.cff b/CITATION.cff
@@ -3,22 +3,28 @@ type: software
 message: If you use this software, please cite it using this metadata.
 
 title: "fair-python-cookiecutter"
-version: "0.1.0"
-abstract: "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
+version: "0.1.1"
+abstract: "An opinionated cookiecutter template to kickstart a modern best-practice
+  Python project with FAIR metadata."
 repository-code: "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
 license: "MIT"
-keywords: [
-    "fair",
-    "metadata",
-    "python",
-    "cookiecutter",
-    "template"
-]
-
+keywords:
+- fair
+- metadata
+- python
+- cookiecutter
+- template
 authors:
-  - family-names: "Pirogov"
-    given-names: "Anton"
-    email: "a.pirogov@fz-juelich.de"
-    orcid: "https://orcid.org/0000-0002-5077-7497"
-    affiliation: "Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9)"
-
+- family-names: Pirogov
+  given-names: Anton
+  email: a.pirogov@fz-juelich.de
+  orcid: https://orcid.org/0000-0002-5077-7497
+  affiliation: Forschungszentrum Jülich GmbH - Institute for Materials Data Science
+    and Informatics (IAS9)
+contact:
+- orcid: https://orcid.org/0000-0002-5077-7497
+  given-names: Anton
+  family-names: Pirogov
+  email: a.pirogov@fz-juelich.de
+url: 
+  https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter
diff --git a/codemeta.json b/codemeta.json
@@ -10,23 +10,27 @@
     "audience": [
         {
             "@type": "Audience",
-            "audienceType": "Science/Research"
+            "audienceType": "Developers"
         },
         {
             "@type": "Audience",
-            "audienceType": "Developers"
+            "audienceType": "Science/Research"
         }
     ],
     "author": [
         {
+            "@id": "https://orcid.org/0000-0002-5077-7497",
             "@type": "Person",
-            "email": "a.pirogov@fz-juelich.de",
+            "affiliation": {
+                "@type": "Organization",
+                "legalName": "Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9)"
+            },
             "familyName": "Pirogov",
             "givenName": "Anton"
         }
     ],
     "codeRepository": "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter",
-    "description": "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. ",
+    "description": "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata.",
     "identifier": "fair-python-cookiecutter",
     "keywords": [
         "cookiecutter",
@@ -54,5 +58,6 @@
             "version": "^3.8"
         }
     ],
+    "url": "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter",
     "version": "0.1.1"
 }
diff --git a/hooks/post_gen_project.sh b/hooks/post_gen_project.sh
@@ -24,13 +24,25 @@ rm tests/test_api.py
 # {% endif %}
 # ----
 
+
 # finalize repo setup
 git init
 poetry install --with docs
 poetry run poe init-dev  # init git repo + register pre-commit
 poetry run pip install pipx  # install pipx into venv without adding it as dep
 poetry run pipx run reuse download --all  # get license files for REUSE compliance
-poetry run poe lint update-codemeta --files pyproject.toml  # to create codemeta.json
+
+# ----
+# if we use somesy, CITATION.cff + codemeta.json is created automatically
+rm CITATION.cff  # using somesy -> will be created from pyproject.toml
+if [ -f "CITATION.cff" ]; then
+    # not using somesy -> create a minimal codemeta.json based on the CITATION.cff
+    # (avoiding the buggy codemetapy pyproject.toml parsing)
+    pipx run cffconvert -i CITATION.cff -f codemeta -o codemeta.json
+fi
+# ----
+# use somesy to create CITATION.cff + codemeta.json
+poetry run poe lint somesy --files pyproject.toml
 
 # create first commit
 git add .
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,6 @@
 # basic configuration:
 site_name: "fair-python-cookiecutter"
-site_description: "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
+site_description: "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata."
 site_url: "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter"
 repo_url: "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
 edit_uri: "blob/main/docs/"
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,26 +1,23 @@
 [tool.poetry]
+# ---- managed by somesy, see .somesy.toml ----
 name = "fair-python-cookiecutter"
 version = "0.1.1"
-description = "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
+description = "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata."
 authors = ["Anton Pirogov <a.pirogov@fz-juelich.de>"]
+maintainers = ["Anton Pirogov <a.pirogov@fz-juelich.de>"]
 license = "MIT"
 
-readme = "README.md"
+keywords = ["fair", "metadata", "python", "cookiecutter", "template"]
 repository = "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
 homepage = "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter"
 documentation = "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter"
+# ---- managed by somesy, see .somesy.toml ----
 
-keywords = [
-    "fair",
-    "metadata",
-    "python",
-    "cookiecutter",
-    "template"
-]
 classifiers = [
     "Intended Audience :: Science/Research",
     "Intended Audience :: Developers",
 ]
+readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.8"
diff --git a/{{ cookiecutter.__project_slug }}/.pre-commit-config.yaml b/{{ cookiecutter.__project_slug }}/.pre-commit-config.yaml
@@ -1,29 +1,13 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-
-  # Various general + format-specific helpers
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-    - id: check-symlinks
-    - id: trailing-whitespace
-    - id: mixed-line-ending
-      args: [--fix=lf]
-    - id: check-yaml
-      exclude: 'mkdocs.yml'
-    - id: check-toml
-    - id: check-json
-    - id: check-ast
-    - id: debug-statements
-    - id: check-merge-conflict
-    - id: check-shebang-scripts-are-executable
-    - id: check-added-large-files
-      args: [--maxkb=10000]
+  # GH Actions
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: '0.22.0'
     hooks:
     - id: check-github-workflows
+
+  # General Python linters and formatters
   - repo: https://github.com/pycqa/isort
     rev: '5.12.0'
     hooks:
@@ -67,7 +51,7 @@ repos:
       args: ['-q', '-c', 'pyproject.toml']
       additional_dependencies: [ '.[toml]' ]
 
-  # Metadata
+  # License Metadata
   - repo: https://github.com/citation-file-format/cff-converter-python
     rev: '44e8fc9'
     hooks:
@@ -77,8 +61,29 @@ repos:
     hooks:
       - id: reuse
 
-  - repo: https://github.com/Materials-Data-Science-and-Informatics/dev-utils
-    rev: 'v0.1.0'
+  # Project Metadata
+  - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
+    rev: "e8bf980" # "0.1.0" TODO: set to tag once released
     hooks:
-      - id: update-codemeta
-        files: ^pyproject.toml$
+      - id: somesy
+
+  # Various general + format-specific helpers
+  # (run last to fix general syntactic defects)
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    - id: check-symlinks
+    - id: trailing-whitespace
+      exclude: 'CITATION.cff'
+    - id: mixed-line-ending
+      args: [--fix=lf]
+    - id: check-yaml
+      exclude: 'mkdocs.yml'
+    - id: check-toml
+    - id: check-json
+    - id: check-ast
+    - id: debug-statements
+    - id: check-merge-conflict
+    - id: check-shebang-scripts-are-executable
+    - id: check-added-large-files
+      args: [--maxkb=10000]
diff --git a/{{ cookiecutter.__project_slug }}/docs/dev_guide.md b/{{ cookiecutter.__project_slug }}/docs/dev_guide.md
@@ -66,6 +66,7 @@ Metadata best practices for FAIR software are implemented using:
 
 * `cffconvert` to check the `CITATION.cff` (citation metadata)
 * `codemetapy` to generate a `codemeta.json` (general software metadata)
+* `somesy` to keep all important metadata continuously synchronized
 * `reuse` to check [REUSE-compliance](https://reuse.software/spec/) (granular copyright and license metadata)
 * `licensecheck` to scan for possible license incompatibilities in the dependencies
 
diff --git a/{{ cookiecutter.__project_slug }}/pyproject.toml b/{{ cookiecutter.__project_slug }}/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -10,23 +10,27 @@`
`10`	`10`	`"audience": [`
`11`	`11`	`{`
`12`	`12`	`"@type": "Audience",`
`13`		`- "audienceType": "Science/Research"`
	`13`	`+ "audienceType": "Developers"`
`14`	`14`	`},`
`15`	`15`	`{`
`16`	`16`	`"@type": "Audience",`
`17`		`- "audienceType": "Developers"`
	`17`	`+ "audienceType": "Science/Research"`
`18`	`18`	`}`
`19`	`19`	`],`
`20`	`20`	`"author": [`
`21`	`21`	`{`
	`22`	`+ "@id": "https://orcid.org/0000-0002-5077-7497",`
`22`	`23`	`"@type": "Person",`
`23`		`- "email": "a.pirogov@fz-juelich.de",`
	`24`	`+ "affiliation": {`
	`25`	`+ "@type": "Organization",`
	`26`	`+ "legalName": "Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9)"`
	`27`	`+ },`
`24`	`28`	`"familyName": "Pirogov",`
`25`	`29`	`"givenName": "Anton"`
`26`	`30`	`}`
`27`	`31`	`],`
`28`	`32`	`"codeRepository": "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter",`
`29`		`- "description": "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. ",`
	`33`	`+ "description": "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata.",`
`30`	`34`	`"identifier": "fair-python-cookiecutter",`
`31`	`35`	`"keywords": [`
`32`	`36`	`"cookiecutter",`
`@@ -54,5 +58,6 @@`
`54`	`58`	`"version": "^3.8"`
`55`	`59`	`}`
`56`	`60`	`],`
	`61`	`+ "url": "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter",`
`57`	`62`	`"version": "0.1.1"`
`58`	`63`	`}`