Merge pull request #33 from Materials-Data-Science-and-Informatics/feature/poetryv2

Feature/poetryv2

Author: mustafasoylu

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ "ubuntu-latest", "macos-latest", "windows-latest" ]
-        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
     runs-on: ${{ matrix.os }}
 
     steps:

.pre-commit-config.yaml

@@ -5,13 +5,13 @@ exclude: 'src/fair_python_cookiecutter/template/.*' # <-- added
 repos:
     # GH Actions
     - repo: https://github.com/python-jsonschema/check-jsonschema
-      rev: '0.28.6'
+      rev: '0.31.2'
       hooks:
           - id: check-github-workflows
 
     # Code Quality
     - repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.5.0
+      rev: v0.9.9
       hooks:
           - id: ruff
             types_or: [python, pyi, jupyter]
@@ -20,7 +20,7 @@ repos:
             types_or: [python, pyi, jupyter]
 
     - repo: https://github.com/pre-commit/mirrors-mypy
-      rev: 'v1.10.1'
+      rev: 'v1.15.0'
       hooks:
           - id: mypy
             args: [--no-strict-optional, --ignore-missing-imports]
@@ -33,18 +33,18 @@ repos:
       hooks:
           - id: validate-cff
     - repo: https://github.com/fsfe/reuse-tool
-      rev: 'v3.0.2'
+      rev: 'v5.0.2'
       hooks:
           - id: reuse
 
     - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
-      rev: 'v0.4.3'
+      rev: 'v0.7.1'
       hooks:
           - id: somesy
 
     # Various general + format-specific helpers
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v4.6.0
+      rev: v5.0.0
       hooks:
           - id: check-symlinks
           - id: trailing-whitespace

.reuse/dep5

@@ -1,6 +1,6 @@
 [project]
 name = "fair-python-cookiecutter"
-version = "0.3.2"
+version = "1.0.0"
 description = "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata. "
 
 license = "MIT"

.somesy.toml

@@ -3,7 +3,7 @@ type: software
 message: If you use this software, please cite it using this metadata.
 
 title: "fair-python-cookiecutter"
-version: "0.3.2"
+version: "1.0.0"
 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"

CITATION.cff

@@ -87,7 +87,7 @@ recommendations on the state of software citation in academic practice.
 
 ## Getting Started
 
-Make sure that you have a working Python interpreter in version at least 3.8,
+Make sure that you have a working Python interpreter in version at least 3.9,
 `git` and [`poetry`](https://python-poetry.org/docs/#installation) installed.
 
 To install the template, run `pip install fair-python-cookiecutter`.

README.md

@@ -0,0 +1,22 @@
+version = 1
+SPDX-PackageName = "fair-python-cookiecutter"
+SPDX-PackageSupplier = "Anton Pirogov <[email protected]>"
+SPDX-PackageDownloadLocation = "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter"
+
+[[annotations]]
+path = ["{{ cookiecutter**"]
+precedence = "override"
+SPDX-FileCopyrightText = "2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <[email protected]>"
+SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = [".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", "**.txt", "docs/**", "REUSE.toml", "somesy.toml"]
+precedence = "override"
+SPDX-FileCopyrightText = "2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <[email protected]>"
+SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = ["src/**", "tests/**", "hooks/**"]
+precedence = "override"
+SPDX-FileCopyrightText = "2023 Forschungszentrum Jülich GmbH - Institute for Materials Data Science and Informatics (IAS9) - Stefan Sandfeld <[email protected]>"
+SPDX-License-Identifier = "MIT"

REUSE.toml

@@ -13,19 +13,21 @@
       "givenName": "Anton",
       "familyName": "Pirogov",
       "email": "[email protected]",
-      "@id": "https://orcid.org/0000-0002-5077-7497"
+      "@id": "https://orcid.org/0000-0002-5077-7497",
+      "identifier": "https://orcid.org/0000-0002-5077-7497"
     },
     {
       "@type": "Person",
       "givenName": "Mustafa",
       "familyName": "Soylu",
       "email": "[email protected]",
-      "@id": "https://orcid.org/0000-0003-2637-0432"
+      "@id": "https://orcid.org/0000-0003-2637-0432",
+      "identifier": "https://orcid.org/0000-0003-2637-0432"
     }
   ],
   "name": "fair-python-cookiecutter",
   "description": "An opinionated cookiecutter template to kickstart a modern best-practice Python project with FAIR metadata.",
-  "version": "0.3.2",
+  "version": "1.0.0",
   "keywords": [
     "fair",
     "metadata",
@@ -39,7 +41,8 @@
       "givenName": "Mustafa",
       "familyName": "Soylu",
       "email": "[email protected]",
-      "@id": "https://orcid.org/0000-0003-2637-0432"
+      "@id": "https://orcid.org/0000-0003-2637-0432",
+      "identifier": "https://orcid.org/0000-0003-2637-0432"
     }
   ],
   "license": [

codemeta.json

@@ -126,6 +126,7 @@ plugins:
 - literate-nav:
     nav_file: SUMMARY.md
 - section-index
+- autorefs
 - mkdocstrings:
     handlers:
       python: