Merge pull request #16 from willynilly/develop

Fixes issue #4. Updates to 5.1.0

Author: willynilly

.github/workflows/check-same-version.yml

@@ -26,7 +26,7 @@ jobs:
           cache: 'pip' # optional and only works for Python projects
 
       - name: Run same-version
-        uses: willynilly/same-version@v5.0.0
+        uses: willynilly/same-version@v5.1.0
         with:
           fail_for_missing_file: false
           check_github_event: true
@@ -42,6 +42,7 @@ jobs:
           check_zenodo_json: true
           zenodo_json_path: .zenodo.json
           check_package_json: false
+          check_setup_cfg: false
           check_setup_py: false
           check_r_description: false
           check_composer_json: false

CITATION.cff

@@ -34,7 +34,7 @@ keywords:
   - metadata
   - harmonization
 license: Apache-2.0
-version: "5.0.0"
+version: "5.1.0"
 date-released: "2025-06-10"
 references:
   - title: Citation File Format

README.md

@@ -57,6 +57,7 @@ This workflow runs after the tag or release exists and can report problems, but
 - `CITATION.cff`
 - `pyproject.toml` (Python)
 - `setup.py` (Python)
+- `setup.cfg` (Python)
 - Python files with `__version__` assignment
 - `codemeta.json` (General)
 - `.zenodo.json` (General)
@@ -147,6 +148,7 @@ For those use cases, specialized dependency resolution libraries (e.g. `packagin
 |------------------|-------------------------|----------------|
 | `CITATION.cff`   | PEP 440 / free text     | Verple |
 | `pyproject.toml` | PEP 440                 | Verple |
+| `setup.cfg`       | PEP 440                 | Verple |
 | `setup.py`       | PEP 440                 | Verple |
 | `package.json`   | SemVer                  | Verple |
 | `codemeta.json`  | Free text               | Verple |
@@ -186,6 +188,8 @@ For those use cases, specialized dependency resolution libraries (e.g. `packagin
 | `--package-json-path`         | `package_json_path`                     | Path to `package.json`               | No    | `package.json`    |
 | `--check-setup-py`            | `check_setup_py`                        | Check `setup.py`? (`true/false`)     | No    | `true`            |
 | `--setup-py-path`             | `setup_py_path`                         | Path to `setup.py`                 | No      | `setup.py`        |
+| `--check-setup-cfg`            | `check_setup_cfg`                        | Check `setup.cfg`? (`true/false`)     | No    | `true`            |
+| `--setup-cfg-path`             | `setup_cfg_path`                         | Path to `setup.cfg`                 | No      | `setup.cfg`        |
 | `--check-py-version-assignment`            | `check_py_version_assignment`                        | Check Python file with `__version__` assignment? (`true/false`)     | No    | `false`            |
 | `--py-version-assignment-path`             | `py_version_assignment_path`                         | Path to Python file with `__version__` assignment                 | No      | *(empty)*        |
 | `--check-composer-json`        | `check_composer_json`                    | Check `composer.json`? (`true/false`)  | No   | `true`            |
@@ -255,7 +259,7 @@ jobs:
           python-version: ">=3.10"
 
       - name: Run same-version
-        uses: willynilly/same-version@v5.0.0
+        uses: willynilly/same-version@v5.1.0
         with:
           fail_for_missing_file: false
           check_github_event: true
@@ -266,6 +270,7 @@ jobs:
           check_citation_cff: true
           check_codemeta_json: true
           check_zenodo_json: true
+          check_setup_cfg: false
           check_setup_py: false
           check_r_description: false
           check_cargo_toml: false
@@ -304,7 +309,7 @@ jobs:
           python-version: ">=3.10"
 
       - name: Run same-version
-        uses: willynilly/same-version@v5.0.0
+        uses: willynilly/same-version@v5.1.0
         with:
           fail_for_missing_file: false
           check_github_event: true
@@ -315,6 +320,7 @@ jobs:
           check_citation_cff: true
           check_codemeta_json: true
           check_zenodo_json: true
+          check_setup_cfg: false
           check_setup_py: false
           check_r_description: false
           check_cargo_toml: false
@@ -341,7 +347,7 @@ Add to your `.pre-commit-config.yaml`:
 ```yaml
 repos:
   - repo: https://github.com/willynilly/same-version
-    rev: v5.0.0  # Use latest tag
+    rev: v5.1.0  # Use latest tag
     hooks:
       - id: same-version
         stages: [pre-commit, pre-push]

action.yml

@@ -105,6 +105,14 @@ inputs:
     description: 'Path to Cargo.toml'
     required: false
     default: 'Cargo.toml'
+  check_setup_cfg:
+    description: 'Check setup.cfg? (true/false)'
+    required: false
+    default: 'true'
+  setup_cfg_path:
+    description: 'Path to setup.cfg'
+    required: false
+    default: 'setup.cfg'
   check_py_version_assignment:
     description: 'Check Python file with __version__ assignment? (true/false)'
     required: false

example.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/willynilly/same-version
-    rev: v5.0.0  # Use latest tag
+    rev: v5.1.0  # Use latest tag
     hooks:
       - id: same-version
         stages: [pre-commit, pre-push]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "same-version"
-version = "5.0.0"
+version = "5.1.0"
 description = "Automatically ensures your software version metadata is consistent across key project files."
 readme = "README.md"
 requires-python = ">=3.10"

src/same_version/checkers/setup_cfg_checker.py

@@ -0,0 +1,10 @@
+from argparse import Namespace
+
+from same_version.checkers.file_checker import FileChecker
+from same_version.extractors.setup_cfg_extractor import SetupCfgExtractor
+
+
+class SetupCfgChecker(FileChecker):
+    
+    def __init__(self, extractor: SetupCfgExtractor, cli_args: Namespace):
+        super().__init__(extractor=extractor, cli_args=cli_args)  

src/same_version/extractors/ini_extractor.py

@@ -0,0 +1,21 @@
+import configparser
+
+from same_version.extractors.file_extractor import FileExtractor
+
+
+class IniExtractor(FileExtractor):
+
+    def _get_data(self) -> dict:
+        data = {}
+        if self.target_file_path and self.target_exists:            
+
+            config = configparser.ConfigParser()
+
+            # configparser lowercases keys by default — we'll preserve case sensitivity for safety
+            setattr(config, 'optionxform', str)
+            config.read(self.target_file_path)
+            data['config'] = config
+
+        return data
+    
+

src/same_version/extractors/setup_cfg_extractor.py

@@ -0,0 +1,28 @@
+from argparse import Namespace
+
+from same_version.extractors.ini_extractor import IniExtractor
+
+
+class SetupCfgExtractor(IniExtractor):
+
+    def __init__(self, cli_args: Namespace):
+        target_cli_parameter_name: str = '--setup-cfg-path'
+        default_target_name: str = "setup.cfg"
+        super().__init__(
+            target_file_path=self._create_target_file_path_from_cli_arg(cli_args=cli_args, cli_arg_parameter=target_cli_parameter_name), 
+            default_target_name=default_target_name, 
+            target_cli_parameter_name=target_cli_parameter_name
+        )
+
+    def _get_version_from_data(self, data: dict) -> str | None:
+        config = data.get('config', None)
+        if config is None:
+            return None
+        metadata = config.get('metadata', None)
+        if metadata is None:
+            return None
+        version = config.get('version', None)
+        if isinstance(version, str):
+            version = version.strip() 
+            
+        return version

src/same_version/main.py

@@ -21,6 +21,7 @@
 from same_version.checkers.ro_crate_metadata_json_checker import (
     RoCrateMetadataJsonChecker,
 )
+from same_version.checkers.setup_cfg_checker import SetupCfgChecker
 from same_version.checkers.setup_py_checker import SetupPyChecker
 from same_version.checkers.zenodo_json_checker import ZenodoJsonChecker
 from same_version.extractors.cargo_toml_extractor import CargoTomlExtractor
@@ -42,6 +43,7 @@
 from same_version.extractors.ro_crate_metadata_json_extractor import (
     RoCrateMetadataJsonExtractor,
 )
+from same_version.extractors.setup_cfg_extractor import SetupCfgExtractor
 from same_version.extractors.setup_py_extractor import SetupPyExtractor
 from same_version.extractors.zenodo_json_extractor import ZenodoJsonExtractor
 from same_version.log_collector import get_log_collector
@@ -62,31 +64,25 @@ def parse_args() -> argparse.Namespace:
     parser.add_argument('--zenodo-json-path', default='.zenodo.json', required=False, help='Path to .zenodo.json')
     parser.add_argument('--check-package-json', default=True, required=False, help='Check package.json? (true/false)')
     parser.add_argument('--package-json-path', default='package.json', required=False, help='Path to package.json')
+    parser.add_argument('--check-setup-cfg', default=True, required=False, help='Check setup.cfg? (true/false)')
+    parser.add_argument('--setup-cfg-path', required=False, help='Path to setup.cfg')
     parser.add_argument('--check-setup-py', default=True, required=False, help='Check setup.py? (true/false)')
     parser.add_argument('--setup-py-path', default='setup.py', required=False, help='Path to setup.py')
-    
     parser.add_argument('--check-r-description', default=True, required=False, help='Check R DESCRIPTION file? (true/false)')
     parser.add_argument('--r-description-path', default='DESCRIPTION', required=False, help='Path to R DESCRIPTION file')
-    
     parser.add_argument('--check-composer-json', default=True, required=False, help='Check setup.py? (true/false)')
     parser.add_argument('--composer-json-path', default='composer.json', required=False, help='Path to composer.json')
-    
     parser.add_argument('--check-pom-xml', default=True, required=False, help='Check pom.xml? (true/false)')
     parser.add_argument('--pom-xml-path', default='pom.xml', required=False, help='Path to pom.xml')
-    
     parser.add_argument('--check-nuspec', default=True, required=False, help='Check .nuspec? (true/false)')
     parser.add_argument('--nuspec-path', default='.nuspec', required=False, help='Path to .nuspec')
-    
     parser.add_argument('--check-cargo-toml', default=True, required=False, help='Check Cargo.toml? (true/false)')
     parser.add_argument('--cargo-toml-path', default='Cargo.toml', required=False, help='Path to Cargo.toml')
-
     parser.add_argument('--check-py-version-assignment', default=False, required=False, help='Check Python file with __version__ assignment? (true/false)')
     parser.add_argument('--py-version-assignment-path', required=False, help='Path to Python file with __version__ assignment')
-    
     parser.add_argument('--check-ro-crate-metadata-json', default=False, required=False, help='Check ro-crate-metadata.json? (true/false)')
     parser.add_argument('--ro-crate-metadata-json-path', default='ro-crate-metadata.json', required=False, help='Path to ro-crate-metadata.json')
     parser.add_argument('--ro-crate-metadata-json-id', required=False, help='@id field for the resource in ro-crate-metadata.json')
-
     parser.add_argument('--check-github-event', default=False, required=False, help='Check GitHub events? (true/false)')
     parser.add_argument('--github-event-name', required=False, help='GitHub event name (push/release)')
     parser.add_argument('--github-event-ref', required=False, help='GitHub ref (for push event)')
@@ -131,6 +127,12 @@ def main():
         setup_py_checker: SetupPyChecker = SetupPyChecker(extractor=setup_py_extractor, cli_args=cli_args)
         checkers.append(setup_py_checker)
 
+    # setup.cfg
+    if str(getattr(cli_args, 'check_setup_cfg', '') or '').lower() == 'true':
+        setup_cfg_extractor: SetupCfgExtractor = SetupCfgExtractor(cli_args=cli_args)
+        setup_cfg_checker: SetupCfgChecker = SetupCfgChecker(extractor=setup_cfg_extractor, cli_args=cli_args)
+        checkers.append(setup_cfg_checker)
+
     # package.json
     if str(getattr(cli_args, 'check_package_json', '') or '').lower() == 'true':
         package_json_extractor: PackageJsonExtractor = PackageJsonExtractor(cli_args=cli_args)
@@ -191,6 +193,8 @@ def main():
         zenodo_json_checker: ZenodoJsonChecker = ZenodoJsonChecker(extractor=zenodo_json_extractor, cli_args=cli_args)
         checkers.append(zenodo_json_checker)
 
+    
+
     # Loop through checkers
     logger.info('📦 Checking software version metadata...')