py-conventional-semver 1.0.0__tar.gz

py_conventional_semver-1.0.0/.scripts/conventional-semver

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-License-Identifier: MIT
+##
+from subprocess import run
+from sys import executable, argv
+result = run([executable, "-m", "py_conventional_semver"] + argv[1:], check=False)

py_conventional_semver-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+© 2026 Shaun Wilson
+(c) 2024 sw4k
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_conventional_semver-1.0.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: py-conventional-semver
+Version: 1.0.0
+Summary: ..a Python fork of sw4k's `conventional-semver` tool.
+Author-email: Shaun Wilson <mrshaunwilson@msn.com>
+License-Expression: MIT
+Project-URL: Documentation, https://conventional-semver.readthedocs.io/
+Project-URL: Homepage, https://github.com/wilson0x4d/conventional-semver
+Project-URL: Repository, https://github.com/wilson0x4d/conventional-semver.git
+Keywords: SEMVER,conventional-semver,conventional-commits,sw4k
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hanaro>=1.0.0
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: punit>=1.4.5; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+
+**conventional-semver** is a [Conventional Commits](https://www.conventionalcommits.org/) processor designed to emit a [SEMVER](https://semver.org) as part of a build pipeline.
+
+## Usage
+
+```text
+Usage:
+        conventional-semver [options] [repo-path]
+
+Options:
+        --help              print usage, then exit.
+        --version           print version info, then exit.
+        --verbose           enable verbose (debug) output.
+        --commit <hash>     indicates which commit hash to start changelog from.
+        --tag <name>        indicates which tag to start changelog from.
+        --changelog <file>  overrides the name of the file the changelog is written to, otherwise 'changelog.md' is the default.
+        --no-semver         disable SEMVER output to STDOUT.
+        --major             SEMVER 'Major' component will start with this value, default is '0'.
+        --minor             SEMVER 'Minor' component will start with this value, default is '0'.
+        --patch             SEMVER 'Patch' component will start with this value, default is '0'.
+        --git-path <path>   overrides the path to `git` tool, otherwise `git` must be in environment PATH.
+
+Parameters:
+        repo-path           the path of the git repository to process, if not specified defaults to working directory.
+```
+
+### Generating SEMVER
+
+When you run **conventional-semver** from within a `git` repository, it will automatically process the log and emit a semver.
+
+Example:
+
+```bash
+% conventional-semver
+0.1.23
+```
+
+This allows you to pull a semver into an Environment Variable, evaluate it as an Argument to another tool, or pipe it to a file/stream for additional processing:
+
+```bash
+% export SEMVER=$(conventional-semver)
+% echo $SEMVER
+0.1.23
+```
+
+#### Override Baseline SEMVER
+
+Projects adopting Conventional Commits may need to customize the baseline SEMVER, rather than starting from `0.0.0`. This can be done with the `--major`, `--minor`, and `--patch` arguments.
+
+When run on a repo containing three non-conventional commits:
+
+```bash
+% conventional-semver --major 1 --minor 2 --patch 3
+1.2.6
+```
+
+#### SEMVER Configuration
+
+When run without any command-line arguments a default set of settings are used which implement a standard Conventional Commits behavior.
+
+To customize behavior a configuration file may be created. This file can be passed in using a `--config` argument, or, placed into one of the following well-known locations (and in the following order):
+
+* `./conventional-semver.conf` (working directory.)
+* `~/.config/conventional-semver/settings.conf` (user profile `.config` directory.)
+* `/etc/conventional-semver/settings.conf` (root `/etc` directory.)
+
+The configuration file should have the following format:
+
+```ini
+# lines starting with hash (#) are comments
+# empty lines, like the following, are ignored
+
+# conventional commit "type" mappings are
+# configured in a [types] section. the following
+# mirrors the default configuration:
+[types]
+.*!=major
+feat.*=minor
+.*=patch
+
+# conventional commit "footer" mappings are
+# configured in a [footers] section. the following
+# mirrors the default configuration:
+[footers]
+BREAKING[\-\.]CHANGE=major
+
+# in each of the above sections, each line
+# represents a key-value pair. the key is a regex
+# and the value is a component type to be
+# incremented if the regex is a match.
+```
+
+There is a sample configuration file located in this repo as `config/conventional-semver.conf` which contains additional comments and explanations, you can customize it to fit your needs and then place it at one of the well-known locations mentioned above.
+
+## Not yet Implemented
+
+### Generating CHANGELOG
+
+To generate a CHANGELOG you specify the `--changelog [filename]` switch, this takes an optional filename argument. If no filename is provided a default filename of `./CHANGELOG` is used to emit a file into the current working directory.
+
+Example:
+
+```bash
+% conventional-semver --changelog
+```
+
+#### CHANGELOG Templates
+
+The CHANGELOG output is controlled through one or more templates. This includes a required "entry" template, and optional "header" and "footer" templates. Combined this is meant to provide enough flexibility that you could emit templates in various structured formats such as XML, JSON, Markdown, etc.
+
+The default templates are meant to produce a generic TEXT file that is markdown-friendly.
+
+##### CHANGELOG Entry Template
+
+For each SEMVER increment a CHANGELOG Entry is emitted.
+
+The format of each CHANGELOG Entry is taken from a file named `changelog-entry.template`, when `--changelog` is specified this file is required to be present or the command will fail.
+
+This is the default content of this template:
+
+```text
+$(DATE) $(SEMVER)-$(HASH)
+$(TYPE)$(SCOPE): $(MESSAGE)
+```
+
+The entry template supports the following expando variables:
+
+| Expando | Comment |
+|-|-|
+| $(DATE) | The date of the commit which caused SEMVER increment. This is emitted in the default culture of the current environment. |
+| $(SEMVER) | The calculated SEMVER value. |
+| $(HASH) | The short-form git commit hash. |
+| $(TYPE) | The Conventional Commits `<type>` value. |
+| $(SCOPE) | If any, the Conventional Commits `[scope]` value, including parenthesis. |
+| $(MESSAGE) | The commit message, sans `<type>` and `[scope]`. |
+| $(BODY) | If any, the commit body. |
+| $(TRAILERS) | If any, the commit trailers (footers). |
+
+##### CHANGELOG Header Template
+
+The header prepended to the CHANGELOG comes from a file named `changelog-header.template`.
+
+There are no special expando variables supported in the header.
+
+##### CHANGELOG Footer Template
+
+The footer appended to the CHANGELOG comes from a file named `changelog-footer.template`.
+
+There are no special expando variables supported in the footer.
+
+##### CHANGELOG Template Caveats
+
+No escaping is performed on any of the emitted values. Thus, it is possible for commit messages to interact with parsers/renderers in unintended ways. For example if you make a template to emit an HTML changelog, and a commit message contains content which looks like an 'element', it will most likely result in a changelog that doesn't render as expected.

py_conventional_semver-1.0.0/README.md

@@ -0,0 +1,153 @@
+
+**conventional-semver** is a [Conventional Commits](https://www.conventionalcommits.org/) processor designed to emit a [SEMVER](https://semver.org) as part of a build pipeline.
+
+## Usage
+
+```text
+Usage:
+        conventional-semver [options] [repo-path]
+
+Options:
+        --help              print usage, then exit.
+        --version           print version info, then exit.
+        --verbose           enable verbose (debug) output.
+        --commit <hash>     indicates which commit hash to start changelog from.
+        --tag <name>        indicates which tag to start changelog from.
+        --changelog <file>  overrides the name of the file the changelog is written to, otherwise 'changelog.md' is the default.
+        --no-semver         disable SEMVER output to STDOUT.
+        --major             SEMVER 'Major' component will start with this value, default is '0'.
+        --minor             SEMVER 'Minor' component will start with this value, default is '0'.
+        --patch             SEMVER 'Patch' component will start with this value, default is '0'.
+        --git-path <path>   overrides the path to `git` tool, otherwise `git` must be in environment PATH.
+
+Parameters:
+        repo-path           the path of the git repository to process, if not specified defaults to working directory.
+```
+
+### Generating SEMVER
+
+When you run **conventional-semver** from within a `git` repository, it will automatically process the log and emit a semver.
+
+Example:
+
+```bash
+% conventional-semver
+0.1.23
+```
+
+This allows you to pull a semver into an Environment Variable, evaluate it as an Argument to another tool, or pipe it to a file/stream for additional processing:
+
+```bash
+% export SEMVER=$(conventional-semver)
+% echo $SEMVER
+0.1.23
+```
+
+#### Override Baseline SEMVER
+
+Projects adopting Conventional Commits may need to customize the baseline SEMVER, rather than starting from `0.0.0`. This can be done with the `--major`, `--minor`, and `--patch` arguments.
+
+When run on a repo containing three non-conventional commits:
+
+```bash
+% conventional-semver --major 1 --minor 2 --patch 3
+1.2.6
+```
+
+#### SEMVER Configuration
+
+When run without any command-line arguments a default set of settings are used which implement a standard Conventional Commits behavior.
+
+To customize behavior a configuration file may be created. This file can be passed in using a `--config` argument, or, placed into one of the following well-known locations (and in the following order):
+
+* `./conventional-semver.conf` (working directory.)
+* `~/.config/conventional-semver/settings.conf` (user profile `.config` directory.)
+* `/etc/conventional-semver/settings.conf` (root `/etc` directory.)
+
+The configuration file should have the following format:
+
+```ini
+# lines starting with hash (#) are comments
+# empty lines, like the following, are ignored
+
+# conventional commit "type" mappings are
+# configured in a [types] section. the following
+# mirrors the default configuration:
+[types]
+.*!=major
+feat.*=minor
+.*=patch
+
+# conventional commit "footer" mappings are
+# configured in a [footers] section. the following
+# mirrors the default configuration:
+[footers]
+BREAKING[\-\.]CHANGE=major
+
+# in each of the above sections, each line
+# represents a key-value pair. the key is a regex
+# and the value is a component type to be
+# incremented if the regex is a match.
+```
+
+There is a sample configuration file located in this repo as `config/conventional-semver.conf` which contains additional comments and explanations, you can customize it to fit your needs and then place it at one of the well-known locations mentioned above.
+
+## Not yet Implemented
+
+### Generating CHANGELOG
+
+To generate a CHANGELOG you specify the `--changelog [filename]` switch, this takes an optional filename argument. If no filename is provided a default filename of `./CHANGELOG` is used to emit a file into the current working directory.
+
+Example:
+
+```bash
+% conventional-semver --changelog
+```
+
+#### CHANGELOG Templates
+
+The CHANGELOG output is controlled through one or more templates. This includes a required "entry" template, and optional "header" and "footer" templates. Combined this is meant to provide enough flexibility that you could emit templates in various structured formats such as XML, JSON, Markdown, etc.
+
+The default templates are meant to produce a generic TEXT file that is markdown-friendly.
+
+##### CHANGELOG Entry Template
+
+For each SEMVER increment a CHANGELOG Entry is emitted.
+
+The format of each CHANGELOG Entry is taken from a file named `changelog-entry.template`, when `--changelog` is specified this file is required to be present or the command will fail.
+
+This is the default content of this template:
+
+```text
+$(DATE) $(SEMVER)-$(HASH)
+$(TYPE)$(SCOPE): $(MESSAGE)
+```
+
+The entry template supports the following expando variables:
+
+| Expando | Comment |
+|-|-|
+| $(DATE) | The date of the commit which caused SEMVER increment. This is emitted in the default culture of the current environment. |
+| $(SEMVER) | The calculated SEMVER value. |
+| $(HASH) | The short-form git commit hash. |
+| $(TYPE) | The Conventional Commits `<type>` value. |
+| $(SCOPE) | If any, the Conventional Commits `[scope]` value, including parenthesis. |
+| $(MESSAGE) | The commit message, sans `<type>` and `[scope]`. |
+| $(BODY) | If any, the commit body. |
+| $(TRAILERS) | If any, the commit trailers (footers). |
+
+##### CHANGELOG Header Template
+
+The header prepended to the CHANGELOG comes from a file named `changelog-header.template`.
+
+There are no special expando variables supported in the header.
+
+##### CHANGELOG Footer Template
+
+The footer appended to the CHANGELOG comes from a file named `changelog-footer.template`.
+
+There are no special expando variables supported in the footer.
+
+##### CHANGELOG Template Caveats
+
+No escaping is performed on any of the emitted values. Thus, it is possible for commit messages to interact with parsers/renderers in unintended ways. For example if you make a template to emit an HTML changelog, and a commit message contains content which looks like an 'element', it will most likely result in a changelog that doesn't render as expected.

py_conventional_semver-1.0.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "py-conventional-semver"
+version = "1.0.0"
+description = "..a Python fork of sw4k's `conventional-semver` tool."
+keywords = ["SEMVER", "conventional-semver", "conventional-commits", "sw4k"]
+authors = [
+    { name="Shaun Wilson", email="mrshaunwilson@msn.com" }
+]
+readme = "README.md"
+license = "MIT"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python"
+]
+requires-python = ">=3.11"
+dependencies = [
+    "hanaro (>=1.0.0)"
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage",
+    "mypy",
+    "punit (>=1.4.5)",
+    "twine"
+]
+
+[project.urls]
+Documentation = "https://conventional-semver.readthedocs.io/"
+Homepage = "https://github.com/wilson0x4d/conventional-semver"
+Repository = "https://github.com/wilson0x4d/conventional-semver.git"
+
+[tool.setuptools.data-files]
+bin = [".scripts/conventional-semver"]
+
+[tool.setuptools.package-data]
+"py-conventional-semver" = ["py.typed"]

py_conventional_semver-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

py_conventional_semver-1.0.0/src/conventional_semver/ChangelogOutputGenerator.py

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import hanaro
+import logging
+
+from .Configuration import Configuration
+from .GitEntry import GitEntry
+from .OutputGenerator import OutputGenerator
+
+
+class ChangelogOutputGenerator(OutputGenerator):
+
+    __config: Configuration
+    __logger: logging.Logger
+
+    def __init__(self, config: Configuration) -> None:
+        self.__config = config
+        self.__logger = hanaro.get_logger()
+
+    def handle_commit_entry(self, entry: GitEntry) -> None:
+        # TODO: implement handling logic
+        self.__logger.warn('TODO: HandleCommitEntry')
+
+    def generate_output(self) -> None:
+        # TODO: implement output generation
+        self.__logger.warn('TODO: GenerateOutput')

py_conventional_semver-1.0.0/src/conventional_semver/CommandLineProcessor.py

@@ -0,0 +1,120 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import sys
+import hanaro
+import logging
+
+from .Configuration import Configuration
+
+
+class CommandlineProcessor:
+
+    __config: Configuration
+    __logger: logging.Logger
+    __paths: list[str]
+
+    def __init__(self, config: Configuration, version: str, commit: str) -> None:
+        self.__commit = commit
+        self.__config = config
+        self.__logger = hanaro.get_logger()
+        self.__paths = [] 
+        self.__version = version
+
+    def __print_info(self) -> None:
+        print(f'conventional-semver {self.__version} ({self.__commit})')
+
+    def __print_usage(self) -> None:
+        print()
+        print('Usage:')
+        print('\conventional-semver [options] [repo-path]')
+        print()
+        print('Options:')
+        print('\t--help              print usage, then exit.')
+        print('\t--version           print version info, then exit.')
+        print('\t--verbose           enable verbose (debug) output.')
+        print('\t--commit <hash>     indicates which commit hash to start changelog from.')
+        print('\t--tag <name>        indicates which tag to start changelog from.')
+        print('\t--changelog <file>  overrides the name of the file the changelog is written to, otherwise \'changelog.md\' is the default.')
+        print('\t--no-semver         disable SEMVER output to STDOUT.')
+        print('\t--major             SEMVER \'Major\' component will start with this value, default is \'0\'.')
+        print('\t--minor             SEMVER \'Minor\' component will start with this value, default is \'0\'.')
+        print('\t--patch             SEMVER \'Patch\' component will start with this value, default is \'0\'.')
+        print('\t--git-path <path>   overrides the path to `git` tool, otherwise `git` must be in environment PATH.')
+        print()
+        print('Parameters:')
+        print('\trepo-path           the path of the git repository to process, if not specified defaults to working directory.')
+        print()
+
+    def process_command_line(self, argv: list[str] | None = None) -> None:
+        if argv is None:
+            argv = sys.argv
+        args = argv[1:]
+        i = 0
+        while i < len(args):
+            arg = args[i]
+            if arg == '--help':
+                self.__print_info()
+                self.__print_usage()
+                sys.exit(0)
+            elif arg == '--version':
+                self.__print_info()
+                sys.exit(0)
+            elif arg == '--no-semver':
+                self.__config.disable_semver_output = True
+            elif arg == '--changelog':
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.changelog_output_file = args[i]
+            elif arg == '--commit':
+                if getattr(self.__config, 'start_tag', ''):
+                    raise RuntimeError('cannot specify both `--commit` and `--tag` options.')
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.start_commit_hash = args[i]
+            elif arg == '--config':
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.config_file = args[i]
+            elif arg == '--git-path':
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.git_path = args[i]
+            elif arg == '--major':
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.major_start = int(args[i])
+            elif arg == '--minor':
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.minor_start = int(args[i])
+            elif arg == '--patch':
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.patch_start = int(args[i])
+            elif arg == '--tag':
+                if getattr(self.__config, 'start_commit_hash', ''):
+                    raise RuntimeError('cannot specify both `--commit` and `--tag` options.')
+                i += 1
+                if i >= len(args) or args[i].startswith('-'):
+                    raise IndexError('missing argument to `' + arg + '` option')
+                self.__config.start_tag = args[i]
+            elif arg == '--verbose':
+                # TODO
+                pass
+            elif not self.__config.repo_path and not arg.startswith('-'):
+                self.__config.repo_path = arg
+            else:
+                self.__print_usage()
+                raise ValueError('unexpected argument: ' + arg)
+            i += 1

py_conventional_semver-1.0.0/src/conventional_semver/Configuration.py

@@ -0,0 +1,160 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import hanaro
+import logging
+import os
+from pathlib import Path
+import re
+
+from .SemverComponentType import SemverComponentType
+
+
+class Configuration:
+
+    changelog_output_file: str
+    config_file: str
+    disable_semver_output: bool
+    footers: list[tuple[re.Pattern, SemverComponentType]]
+    git_path: str
+    major_start: int
+    minor_start: int
+    patch_start: int
+    start_commit_hash: str
+    start_tag: str
+    types: list[tuple[re.Pattern, SemverComponentType]]
+    repo_path: str
+
+    __logger: logging.Logger
+
+    def __init__(self) -> None:
+        self.__logger = hanaro.get_logger()
+
+        self.changelog_output_file = ''
+        self.config_file = ''
+        self.disable_semver_output = False
+        self.footers = []
+        self.git_path = ''
+        self.major_start = 0
+        self.minor_start = 0
+        self.patch_start = 0
+        self.start_commit_hash = ''
+        self.start_tag = ''
+        self.types = []
+        self.repo_path = ''
+
+    def __build_footer_regex(self, input_str: str) -> re.Pattern:
+        pattern = r'[\S\s]*' + input_str + r'[\S\s]*'
+        return re.compile(pattern, re.MULTILINE | re.IGNORECASE)
+
+    def __build_type_regex(self, input_str: str) -> re.Pattern:
+        pattern = r'^' + input_str + r':[\S\s]*'
+        return re.compile(pattern, re.MULTILINE | re.IGNORECASE)
+
+    def __create_entry(self, entry: str, entry_code: str) -> bool:
+        idx = entry.find('=')
+        if idx == -1:
+            return False
+
+        regex = self.__build_type_regex(entry[:idx].strip())
+
+        value_part = entry[idx + 1 :].strip()
+        if not value_part:
+            return False
+        component_code = value_part[0].lower()
+
+        component_type = None
+        if component_code == 'j':
+            component_type = SemverComponentType.MAJOR
+        elif component_code == 'n':
+            component_type = SemverComponentType.MINOR
+        elif component_code == 't':
+            component_type = SemverComponentType.PATCH
+        else:
+            return False
+
+        if entry_code == 't':
+            self.types.append((regex, component_type))
+        elif entry_code == 'f':
+            self.footers.append((regex, component_type))
+        else:
+            return False
+
+        return True
+
+    def __process_configuration_file(self, path: str) -> bool:
+        config_path = Path(path).expanduser()
+        if not config_path.is_file():
+            return False
+
+        entry_type = '?'  # tracks whether we are inside [types] or [footers]
+
+        with config_path.open('r', encoding='utf-8') as stream:
+            for raw_line in stream:
+                line = raw_line.rstrip('\n')
+                if not line or line.startswith('#'):
+                    continue
+                if line == '[types]':
+                    entry_type = 't'
+                elif line == '[footers]':
+                    entry_type = 'f'
+                else:
+                    if not self.__create_entry(line, entry_type):
+                        self.__logger.warn('Could not configure entry from: ' + line)
+        return True
+
+    def __print_configuration_summary(self) -> None:
+        # TODO: 
+        pass
+
+    def process_configuration(self) -> None:
+        config_processed = False
+
+        if self.config_file:
+            config_processed = self.__process_configuration_file(self.config_file)
+            if not config_processed:
+                raise RuntimeError(
+                    f'Failed to process expected configuration file: {self.config_file}'
+                )
+        else:
+            candidate_paths = [
+                './conventional-semver.json',
+                os.path.expanduser('~/.config/conventional-semver/settings.json'),
+                '/etc/conventional-semver/settings.json',
+            ]
+            for cand in candidate_paths:
+                if self.__process_configuration_file(cand):
+                    config_processed = True
+                    break
+
+            if not config_processed:
+                # apply a default set of regexes
+                self.types.append(
+                    (self.__build_type_regex('.*!'), SemverComponentType.MAJOR)
+                )
+                self.types.append(
+                    (self.__build_type_regex('feat.*'), SemverComponentType.MINOR)
+                )
+                self.types.append(
+                    (self.__build_type_regex('.*'), SemverComponentType.PATCH)
+                )
+                self.footers.append(
+                    (
+                        self.__build_footer_regex(r'BREAKING[\-\.]CHANGE'),
+                        SemverComponentType.MAJOR,
+                    )
+                )
+
+        if not self.repo_path:
+            self.repo_path = str(Path.cwd())
+
+        if (self.start_commit_hash or self.start_tag) and not self.changelog_output_file:
+            self.changelog_output_file = str(Path.cwd() / 'changelog.md')
+
+        if not self.git_path:
+            self.git_path = 'git'
+
+        self.__print_configuration_summary()

py_conventional_semver-1.0.0/src/conventional_semver/GitAdapter.py

@@ -0,0 +1,67 @@
+# git_adapter.py  (only the relevant parts are shown)
+
+import hanaro
+import logging
+import os
+import subprocess
+import sys
+
+from .Configuration import Configuration
+from .GitEntryParser import GitEntryParser
+from .GitLogStream import GitLogStream
+from .OutputGenerator import OutputGenerator
+
+
+class GitAdapter:
+
+    __config: Configuration
+    __git_log_stream: GitLogStream
+    __logger: logging.Logger
+    __output_generators: list[OutputGenerator]
+
+    def __init__(
+        self,
+        config: Configuration,
+        git_entry_parser: GitEntryParser,
+        output_generators: list[OutputGenerator],
+    ) -> None:
+        self.__config = config
+        self.__logger = hanaro.get_logger()
+        self.__git_log_stream = GitLogStream(git_entry_parser)
+        self.__output_generators = list(output_generators)
+
+    def process_git_log(self) -> None:
+        argv = [
+            self.__config.git_path,
+            '--no-pager',
+            '-C',
+            self.__config.repo_path,
+            'log',
+            '--reverse',
+            '--format=tformat:%H%n%D%n%B%n%xef',
+        ]
+        try:
+            proc = subprocess.Popen(
+                argv,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                cwd=self.__config.repo_path,
+            )
+        except OSError as ex:
+            raise RuntimeError(f'Failed to start git: {ex}') from ex
+
+        stdout_bytes, stderr_bytes = proc.communicate()
+
+        if stderr_bytes:
+            os.write(sys.stderr.fileno(), stderr_bytes)
+
+        self.__git_log_stream.write(stdout_bytes, len(stdout_bytes))
+
+        entry = self.__git_log_stream.readentry()
+        while not entry.is_empty():
+            for generator in self.__output_generators:
+                generator.handle_commit_entry(entry)
+            entry = self.__git_log_stream.readentry()
+
+        if proc.returncode != 0:
+            self.__logger.error(f'git process exited with non-zero code {proc.returncode}')

py_conventional_semver-1.0.0/src/conventional_semver/GitEntry.py

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+from typing import Optional
+
+
+class GitEntry:
+
+    def __init__(
+        self,
+        commit_hash: str = '',
+        body: str = '',
+        footers: Optional[list[str]] = None,
+        refs: Optional[list[str]] = None,
+        subject: str = '',
+    ) -> None:
+        self.commit_hash = commit_hash
+        self.body = body
+        self.footers = footers if footers is not None else []
+        self.refs = refs if refs is not None else []
+        self.subject = subject
+
+    def is_empty(self) -> bool:
+        """Return ``True`` when the entry contains no data."""
+        return (
+            not self.commit_hash
+            and not self.body
+            and not self.footers
+            and not self.refs
+            and not self.subject
+        )
+
+    def __str__(self) -> str:
+        """Produce a string representation of the git entry."""
+        if self.is_empty():
+            return ''
+
+        result = self.commit_hash + '\n'
+
+        if self.refs:
+            result += ', '.join(self.refs)
+
+        result += '\n' + self.subject + '\n\n' + self.body + '\n'
+
+        if self.footers:
+            result += ','.join(self.footers)
+
+        return result

py_conventional_semver-1.0.0/src/conventional_semver/GitEntryParser.py

@@ -0,0 +1,58 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+from .GitEntry import GitEntry
+
+
+class GitEntryParser:
+
+    def parse(self, input_str: str) -> GitEntry:
+        if not input_str:
+            return GitEntry()
+
+        entry = GitEntry()
+
+        lines = input_str.split('\n')
+
+        entry.commit_hash = lines[0]
+
+        refs_raw = lines[1]
+        if refs_raw:
+            entry.refs = [
+                ref.strip()
+                for ref in refs_raw.split(',')
+                if ref
+            ]
+
+        try:
+            subject_end = lines.index('', 2)
+        except ValueError:
+            subject_end = len(lines)
+
+        subject_lines = lines[2:subject_end]
+        entry.subject = '\n'.join(subject_lines)
+
+        body_start = subject_end + 1
+        if body_start < len(lines):
+            try:
+                body_end = lines.index('', body_start)
+            except ValueError:
+                body_end = len(lines)
+
+            body_lines = lines[body_start:body_end]
+            entry.body = '\n'.join(body_lines)
+
+            footer_start = body_end + 1
+            if footer_start < len(lines):
+                entry.footers = [
+                    footer
+                    for footer in lines[footer_start:]
+                    if footer
+                ]
+            else:
+                entry.footers = []
+
+        return entry

py_conventional_semver-1.0.0/src/conventional_semver/GitLogStream.py

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+from .GitEntry import GitEntry
+from .GitEntryParser import GitEntryParser
+
+
+class GitLogStream:
+
+    __git_entry_parser: GitEntryParser
+    __buffer: bytearray
+
+    def __init__(
+        self,
+        git_entry_parser: GitEntryParser
+    ) -> None:
+        self.__buffer = bytearray()
+        self.__git_entry_parser = git_entry_parser
+
+    def write(self, buf: bytes, count: int) -> None:
+        self.__buffer.extend(buf[:count])
+
+    def readentry(self) -> GitEntry:
+        terminator = 0xEF
+        try:
+            term_index = self.__buffer.index(terminator)
+        except ValueError:
+            return GitEntry()
+
+        entry_bytes = self.__buffer[:term_index]
+        del self.__buffer[: term_index + 2]
+
+        try:
+            entry_str = entry_bytes.decode('utf-8')
+        except UnicodeDecodeError:
+            entry_str = entry_bytes.decode('utf-8', errors='replace')
+        return self.__git_entry_parser.parse(entry_str.strip())

py_conventional_semver-1.0.0/src/conventional_semver/OutputGenerator.py

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+from typing import Protocol, runtime_checkable
+
+from .GitEntry import GitEntry
+
+
+@runtime_checkable
+class OutputGenerator(Protocol):
+
+    def handle_commit_entry(self, entry: GitEntry) -> None:
+        ...
+
+    def generate_output(self) -> None:
+        ...

py_conventional_semver-1.0.0/src/conventional_semver/SemverComponentType.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from enum import IntEnum
+
+
+class SemverComponentType(IntEnum):
+    NONE = 0
+    PATCH = 1
+    MINOR = 2
+    MAJOR = 3

py_conventional_semver-1.0.0/src/conventional_semver/SemverOutputGenerator.py

@@ -0,0 +1,55 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+from .Configuration import Configuration
+from .GitEntry import GitEntry
+from .OutputGenerator import OutputGenerator
+from .SemverComponentType import SemverComponentType
+
+
+class SemverOutputGenerator(OutputGenerator):
+
+    __config: Configuration
+    __major: int
+    __minor: int
+    __patch: int
+
+    def __init__(self, config: Configuration) -> None:
+        self.__config = config
+        self.__major = config.major_start
+        self.__minor = config.minor_start
+        self.__patch = config.patch_start
+
+    def handle_commit_entry(self, entry: GitEntry) -> None:
+        if entry.is_empty():
+            return
+
+        semver_component = SemverComponentType.NONE
+
+        for regex, comp in self.__config.types:
+            if comp.value > semver_component.value:
+                if regex.search(entry.subject):
+                    semver_component = comp
+
+        for regex, comp in self.__config.footers:
+            if comp.value > semver_component.value:
+                for footer in entry.footers:
+                    if regex.search(footer):
+                        semver_component = comp
+                        break
+
+        if semver_component == SemverComponentType.MAJOR:
+            self.__major += 1
+            self.__minor = 0
+            self.__patch = 0
+        elif semver_component == SemverComponentType.MINOR:
+            self.__minor += 1
+            self.__patch = 0
+        elif semver_component == SemverComponentType.PATCH:
+            self.__patch += 1
+
+    def generate_output(self) -> None:
+        print(f'{self.__major}.{self.__minor}.{self.__patch}')

py_conventional_semver-1.0.0/src/conventional_semver/__init__.py

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-License-Identifier: MIT
+
+from .ChangelogOutputGenerator import ChangelogOutputGenerator
+from .CommandLineProcessor import CommandlineProcessor
+from .Configuration import Configuration
+from .GitAdapter import GitAdapter
+from .GitEntry import GitEntry
+from .GitEntryParser import GitEntryParser
+from .GitLogStream import GitLogStream
+from .OutputGenerator import OutputGenerator
+from .SemverOutputGenerator import SemverOutputGenerator
+from .SemverComponentType import SemverComponentType
+
+__version__ = '1.0.0'
+__commit__ = '11d7129'
+__all__ = [
+    '__version__', '__commit__',
+    'ChangelogOutputGenerator',
+    'CommandlineProcessor',
+    'Configuration',
+    'GitAdapter',
+    'GitEntry',
+    'GitEntryParser',
+    'GitLogStream',
+    'OutputGenerator',
+    'SemverOutputGenerator',
+    'SemverComponentType',
+]

py_conventional_semver-1.0.0/src/conventional_semver/__main__.py

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: © 2026 Shaun Wilson
+# SPDX-FileCopyrightText: (c) 2024 sw4k 
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+import sys
+
+from .Configuration import Configuration
+from .CommandLineProcessor import CommandlineProcessor
+from .ChangelogOutputGenerator import ChangelogOutputGenerator
+from .GitEntryParser import GitEntryParser
+from .GitAdapter import GitAdapter
+from .OutputGenerator import OutputGenerator
+from .SemverOutputGenerator import SemverOutputGenerator
+from . import __version__, __commit__
+
+
+def main(argv: list[str]) -> int:
+    config = Configuration()
+    cmd_processor = CommandlineProcessor(config, __version__, __commit__)
+    cmd_processor.process_command_line(argv)
+    config.process_configuration()
+    output_generators = list[OutputGenerator]()
+    if not config.disable_semver_output:
+        output_generators.append(SemverOutputGenerator(config))
+    if config.changelog_output_file:
+        output_generators.append(ChangelogOutputGenerator(config))
+    git_entry_parser = GitEntryParser()
+    git_adapter = GitAdapter(
+        config,
+        git_entry_parser,
+        output_generators,
+    )
+    git_adapter.process_git_log()
+    for generator in output_generators:
+        generator.generate_output()
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv))

py_conventional_semver-1.0.0/src/py_conventional_semver.egg-info/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: py-conventional-semver
+Version: 1.0.0
+Summary: ..a Python fork of sw4k's `conventional-semver` tool.
+Author-email: Shaun Wilson <mrshaunwilson@msn.com>
+License-Expression: MIT
+Project-URL: Documentation, https://conventional-semver.readthedocs.io/
+Project-URL: Homepage, https://github.com/wilson0x4d/conventional-semver
+Project-URL: Repository, https://github.com/wilson0x4d/conventional-semver.git
+Keywords: SEMVER,conventional-semver,conventional-commits,sw4k
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: hanaro>=1.0.0
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: punit>=1.4.5; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+
+**conventional-semver** is a [Conventional Commits](https://www.conventionalcommits.org/) processor designed to emit a [SEMVER](https://semver.org) as part of a build pipeline.
+
+## Usage
+
+```text
+Usage:
+        conventional-semver [options] [repo-path]
+
+Options:
+        --help              print usage, then exit.
+        --version           print version info, then exit.
+        --verbose           enable verbose (debug) output.
+        --commit <hash>     indicates which commit hash to start changelog from.
+        --tag <name>        indicates which tag to start changelog from.
+        --changelog <file>  overrides the name of the file the changelog is written to, otherwise 'changelog.md' is the default.
+        --no-semver         disable SEMVER output to STDOUT.
+        --major             SEMVER 'Major' component will start with this value, default is '0'.
+        --minor             SEMVER 'Minor' component will start with this value, default is '0'.
+        --patch             SEMVER 'Patch' component will start with this value, default is '0'.
+        --git-path <path>   overrides the path to `git` tool, otherwise `git` must be in environment PATH.
+
+Parameters:
+        repo-path           the path of the git repository to process, if not specified defaults to working directory.
+```
+
+### Generating SEMVER
+
+When you run **conventional-semver** from within a `git` repository, it will automatically process the log and emit a semver.
+
+Example:
+
+```bash
+% conventional-semver
+0.1.23
+```
+
+This allows you to pull a semver into an Environment Variable, evaluate it as an Argument to another tool, or pipe it to a file/stream for additional processing:
+
+```bash
+% export SEMVER=$(conventional-semver)
+% echo $SEMVER
+0.1.23
+```
+
+#### Override Baseline SEMVER
+
+Projects adopting Conventional Commits may need to customize the baseline SEMVER, rather than starting from `0.0.0`. This can be done with the `--major`, `--minor`, and `--patch` arguments.
+
+When run on a repo containing three non-conventional commits:
+
+```bash
+% conventional-semver --major 1 --minor 2 --patch 3
+1.2.6
+```
+
+#### SEMVER Configuration
+
+When run without any command-line arguments a default set of settings are used which implement a standard Conventional Commits behavior.
+
+To customize behavior a configuration file may be created. This file can be passed in using a `--config` argument, or, placed into one of the following well-known locations (and in the following order):
+
+* `./conventional-semver.conf` (working directory.)
+* `~/.config/conventional-semver/settings.conf` (user profile `.config` directory.)
+* `/etc/conventional-semver/settings.conf` (root `/etc` directory.)
+
+The configuration file should have the following format:
+
+```ini
+# lines starting with hash (#) are comments
+# empty lines, like the following, are ignored
+
+# conventional commit "type" mappings are
+# configured in a [types] section. the following
+# mirrors the default configuration:
+[types]
+.*!=major
+feat.*=minor
+.*=patch
+
+# conventional commit "footer" mappings are
+# configured in a [footers] section. the following
+# mirrors the default configuration:
+[footers]
+BREAKING[\-\.]CHANGE=major
+
+# in each of the above sections, each line
+# represents a key-value pair. the key is a regex
+# and the value is a component type to be
+# incremented if the regex is a match.
+```
+
+There is a sample configuration file located in this repo as `config/conventional-semver.conf` which contains additional comments and explanations, you can customize it to fit your needs and then place it at one of the well-known locations mentioned above.
+
+## Not yet Implemented
+
+### Generating CHANGELOG
+
+To generate a CHANGELOG you specify the `--changelog [filename]` switch, this takes an optional filename argument. If no filename is provided a default filename of `./CHANGELOG` is used to emit a file into the current working directory.
+
+Example:
+
+```bash
+% conventional-semver --changelog
+```
+
+#### CHANGELOG Templates
+
+The CHANGELOG output is controlled through one or more templates. This includes a required "entry" template, and optional "header" and "footer" templates. Combined this is meant to provide enough flexibility that you could emit templates in various structured formats such as XML, JSON, Markdown, etc.
+
+The default templates are meant to produce a generic TEXT file that is markdown-friendly.
+
+##### CHANGELOG Entry Template
+
+For each SEMVER increment a CHANGELOG Entry is emitted.
+
+The format of each CHANGELOG Entry is taken from a file named `changelog-entry.template`, when `--changelog` is specified this file is required to be present or the command will fail.
+
+This is the default content of this template:
+
+```text
+$(DATE) $(SEMVER)-$(HASH)
+$(TYPE)$(SCOPE): $(MESSAGE)
+```
+
+The entry template supports the following expando variables:
+
+| Expando | Comment |
+|-|-|
+| $(DATE) | The date of the commit which caused SEMVER increment. This is emitted in the default culture of the current environment. |
+| $(SEMVER) | The calculated SEMVER value. |
+| $(HASH) | The short-form git commit hash. |
+| $(TYPE) | The Conventional Commits `<type>` value. |
+| $(SCOPE) | If any, the Conventional Commits `[scope]` value, including parenthesis. |
+| $(MESSAGE) | The commit message, sans `<type>` and `[scope]`. |
+| $(BODY) | If any, the commit body. |
+| $(TRAILERS) | If any, the commit trailers (footers). |
+
+##### CHANGELOG Header Template
+
+The header prepended to the CHANGELOG comes from a file named `changelog-header.template`.
+
+There are no special expando variables supported in the header.
+
+##### CHANGELOG Footer Template
+
+The footer appended to the CHANGELOG comes from a file named `changelog-footer.template`.
+
+There are no special expando variables supported in the footer.
+
+##### CHANGELOG Template Caveats
+
+No escaping is performed on any of the emitted values. Thus, it is possible for commit messages to interact with parsers/renderers in unintended ways. For example if you make a template to emit an HTML changelog, and a commit message contains content which looks like an 'element', it will most likely result in a changelog that doesn't render as expected.

py_conventional_semver-1.0.0/src/py_conventional_semver.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+LICENSE
+README.md
+pyproject.toml
+.scripts/conventional-semver
+src/conventional_semver/ChangelogOutputGenerator.py
+src/conventional_semver/CommandLineProcessor.py
+src/conventional_semver/Configuration.py
+src/conventional_semver/GitAdapter.py
+src/conventional_semver/GitEntry.py
+src/conventional_semver/GitEntryParser.py
+src/conventional_semver/GitLogStream.py
+src/conventional_semver/OutputGenerator.py
+src/conventional_semver/SemverComponentType.py
+src/conventional_semver/SemverOutputGenerator.py
+src/conventional_semver/__init__.py
+src/conventional_semver/__main__.py
+src/py_conventional_semver.egg-info/PKG-INFO
+src/py_conventional_semver.egg-info/SOURCES.txt
+src/py_conventional_semver.egg-info/dependency_links.txt
+src/py_conventional_semver.egg-info/requires.txt
+src/py_conventional_semver.egg-info/top_level.txt

py_conventional_semver-1.0.0/src/py_conventional_semver.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_conventional_semver-1.0.0/src/py_conventional_semver.egg-info/requires.txt

@@ -0,0 +1,7 @@
+hanaro>=1.0.0
+
+[dev]
+coverage
+mypy
+punit>=1.4.5
+twine

py_conventional_semver-1.0.0/src/py_conventional_semver.egg-info/top_level.txt

@@ -0,0 +1 @@
+conventional_semver