python-kacl 0.4.6__tar.gz → 0.5.0__tar.gz

{python-kacl-0.4.6/python_kacl.egg-info → python_kacl-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-kacl
-Version: 0.4.6
+Version: 0.5.0
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Home-page: https://gitlab.com/schmieder.matthias/python-kacl.git
 Author: Matthias Schmieder
@@ -14,6 +14,10 @@ Classifier: Topic :: Software Development :: Version Control
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: semver
+Requires-Dist: gitpython
+Requires-Dist: pyyaml
 
 # python-kacl
 
@@ -437,13 +441,12 @@ in order to generate the correct urls, `python-kacl` allows you to define three
 
 ```yaml
 kacl:
-  git:
-    links:
-        # The host url is optional and will be automatically determined using your the git repository. If run on gitlab CI the host will be determined by CI_PROJECT_URL if not specified here.
-        host_url: https://github.com/mschmieder/kacl-cli
-        compare_versions_template: '{host}/compare/v{previous_version}...v{version}'
-        unreleased_changes_template: '{host}/tree/v{latest_version}...HEAD'
-        initial_version_template: '{host}/tree/v{version}'
+  links:
+    # The host url is optional and will be automatically determined using your git repository. If run on gitlab CI the host will be determined by CI_PROJECT_URL if not specified here.
+    host_url: https://github.com/mschmieder/kacl-cli
+    compare_versions_template: '{host}/compare/v{previous_version}...v{version}'
+    unreleased_changes_template: '{host}/compare/v{latest_version}...HEAD'
+    initial_version_template: '{host}/tree/v{version}'
 ```
 
 Using the python format syntax you can generate any links you want. The available replacement variables are `version`, `previous_version`, `host` and `latest_version`.
@@ -550,7 +553,7 @@ kacl:
     tag_name: "v{new_version}"
     tag_description: "Version v{new_version} released"
   links:
-      # The host url is optional and will be automatically determined using your the git repository
+      # The host url is optional and will be automatically determined using your git repository
       # host_url: https://github.com/mschmieder/kacl-cli
       compare_versions_template: '{host}/compare/{previous_version}...{version}'
       unreleased_changes_template: '{host}/compare/{latest_version}...master'
@@ -577,7 +580,7 @@ source ./venv/bin/activate
 pip install -e .
 
 # install development requirements
-pip install -r dev-requirements
+pip install -r dev-requirements.txt
 
 # run the tests
 python3 -m pytest --snapshot-update --allow-snapshot-deletion

{python-kacl-0.4.6 → python_kacl-0.5.0}/README.md

@@ -420,13 +420,12 @@ in order to generate the correct urls, `python-kacl` allows you to define three
 
 ```yaml
 kacl:
-  git:
-    links:
-        # The host url is optional and will be automatically determined using your the git repository. If run on gitlab CI the host will be determined by CI_PROJECT_URL if not specified here.
-        host_url: https://github.com/mschmieder/kacl-cli
-        compare_versions_template: '{host}/compare/v{previous_version}...v{version}'
-        unreleased_changes_template: '{host}/tree/v{latest_version}...HEAD'
-        initial_version_template: '{host}/tree/v{version}'
+  links:
+    # The host url is optional and will be automatically determined using your git repository. If run on gitlab CI the host will be determined by CI_PROJECT_URL if not specified here.
+    host_url: https://github.com/mschmieder/kacl-cli
+    compare_versions_template: '{host}/compare/v{previous_version}...v{version}'
+    unreleased_changes_template: '{host}/compare/v{latest_version}...HEAD'
+    initial_version_template: '{host}/tree/v{version}'
 ```
 
 Using the python format syntax you can generate any links you want. The available replacement variables are `version`, `previous_version`, `host` and `latest_version`.
@@ -533,7 +532,7 @@ kacl:
     tag_name: "v{new_version}"
     tag_description: "Version v{new_version} released"
   links:
-      # The host url is optional and will be automatically determined using your the git repository
+      # The host url is optional and will be automatically determined using your git repository
       # host_url: https://github.com/mschmieder/kacl-cli
       compare_versions_template: '{host}/compare/{previous_version}...{version}'
       unreleased_changes_template: '{host}/compare/{latest_version}...master'
@@ -560,7 +559,7 @@ source ./venv/bin/activate
 pip install -e .
 
 # install development requirements
-pip install -r dev-requirements
+pip install -r dev-requirements.txt
 
 # run the tests
 python3 -m pytest --snapshot-update --allow-snapshot-deletion

{python-kacl-0.4.6 → python_kacl-0.5.0}/kacl/__init__.py

@@ -1,5 +1,5 @@
 # Version of the python-kacl package
-__version__ = "0.4.6"
+__version__ = "0.5.0"
 
 from kacl.document import KACLDocument
 from kacl.serializer import KACLMarkdownSerializer

{python-kacl-0.4.6 → python_kacl-0.5.0}/kacl/document.py

@@ -220,7 +220,14 @@ class KACLDocument:
             self.__versions.insert(0, unreleased_version)
         unreleased_version.add(section.capitalize(), data)
 
-    def release(self, version=None, link=None, auto_link=False, increment=None):
+    def release(
+        self,
+        version=None,
+        link=None,
+        auto_link=False,
+        increment=None,
+        allow_no_changes=False,
+    ):
         """Creates a new release version by copying the 'unreleased' changes into the
         new version
 
@@ -228,24 +235,14 @@ class KACLDocument:
             link {[str]} -- url the version will be linked with (default: {None})
             version {[str]} -- semantic versioning string
             increment {[str]} -- use either 'patch', 'minor', or 'major' to automatically increment the last version
+            allow_no_changes {[bool]} -- allow releasing a version without changes (default: {False})
         """
+
+        # check if 'post_release_version_prefix' is set
+        post_release_version_prefix = self.config.post_release_version_prefix
+
         if increment:
-            v = self.current_version()
-            if v:
-                sv = semver.VersionInfo.parse(v)
-                if "post" == increment:
-                    sv = sv.bump_prerelease(token="post")
-                elif "patch" == increment:
-                    sv = sv.bump_patch()
-                elif "minor" == increment:
-                    sv = sv.bump_minor()
-                elif "major" == increment:
-                    sv = sv.bump_major()
-                version = str(sv)
-            else:
-                raise KACLException(
-                    "No previously released version found. Incrementing not possible"
-                )
+            version = self.next_version(increment=increment)
 
         # check that version is a valid semantic version
         future_version = semver.VersionInfo.parse(
@@ -253,7 +250,7 @@ class KACLDocument:
         )  # --> will throw a ValueError if version is not a valid semver
 
         # check if there are changes to release
-        if self.has_changes() is False:
+        if not allow_no_changes and not self.has_changes():
             raise KACLException(
                 "The current changelog has no changes. You can only release if changes are available."
             )
@@ -282,8 +279,6 @@ class KACLDocument:
                 patch=future_version.patch,
             )
 
-            # check if 'post_release_version_prefix' is set
-            post_release_version_prefix = self.config.post_release_version_prefix
             comp_result = 0
             if post_release_version_prefix:
                 #   2.1 Check if 'future version' is a 'post version'
@@ -376,6 +371,36 @@ class KACLDocument:
         if res and len(res):
             return res[0]
 
+    def next_version(self, increment="patch"):
+        """returns the current version (last released)
+        increment {[str]} -- use either 'patch', 'minor', or 'major' to automatically increment the last version
+        Returns:
+            [str] -- latest released version, None if none is available
+        """
+        v = self.current_version()
+        next_version = None
+        if v:
+            sv = semver.VersionInfo.parse(v)
+            if "post" == increment:
+                if not self.config.post_release_version_prefix:
+                    raise KACLException(
+                        "No 'post_release_version_prefix' set in the config. Incrementing not possible"
+                    )
+                sv = sv.bump_prerelease(token=self.config.post_release_version_prefix)
+            elif "patch" == increment:
+                sv = sv.bump_patch()
+            elif "minor" == increment:
+                sv = sv.bump_minor()
+            elif "major" == increment:
+                sv = sv.bump_major()
+            next_version = str(sv)
+        else:
+            raise KACLException(
+                "No previously released version found. Incrementing not possible"
+            )
+
+        return next_version
+
     def current_version(self):
         """returns the current version (last released)
 

{python-kacl-0.4.6 → python_kacl-0.5.0}/kacl/kacl_cli.py

@@ -15,6 +15,35 @@ from kacl.config import KACLConfig
 from kacl.exception import KACLException
 
 
+def check_auto_increment(version):
+    # check if the version string indicates automatic increment
+    increment = None
+    if version in ["major", "minor", "patch", "post"]:
+        increment = version
+        version = None  # reset
+    else:
+        # check if version is a valid semantic version
+        try:
+            semver.VersionInfo.parse(version)
+        except Exception:
+            click.echo(
+                click.style("Error: ", fg="red")
+                + f'"{version}" not a valid semantic version.'
+            )
+            sys.exit(1)
+
+    return version, increment
+
+
+def raise_on_invalid(kacl_changelog):
+    if not kacl_changelog.is_valid():
+        click.echo(
+            click.style("Error: ", fg="red")
+            + "Changelog is not valid. Run 'kacl-cli verify' for more information."
+        )
+        sys.exit(1)
+
+
 def load_changelog(ctx):
     config_file_path = ctx.obj["config"]
     input_file = ctx.obj["file"]
@@ -124,6 +153,27 @@ def current(ctx):
     click.echo(current_version)
 
 
+@cli.command()
+@click.pass_context
+@click.argument("version", type=str)
+def next(ctx, version):
+    """Returns the next version based on the current version from the Changelog."""
+    kacl_changelog = load_changelog(ctx)
+    raise_on_invalid(kacl_changelog)
+
+    version, increment = check_auto_increment(version)
+
+    if increment:
+        version = kacl_changelog.next_version(increment=increment)
+
+    # check that version is a valid semantic version
+    future_version = semver.VersionInfo.parse(
+        version
+    )  # --> will throw a ValueError if version is not a valid semver
+
+    click.echo(future_version)
+
+
 @cli.command()
 @click.pass_context
 @click.argument("version", type=str)
@@ -343,6 +393,11 @@ def verify(ctx, as_json):
     is_flag=True,
     help='If passed this will allow to commit/tag even on a "dirty".',
 )
+@click.option(
+    "--allow-no-changes",
+    is_flag=True,
+    help="If passed this will allow to release without any changes.",
+)
 def release(
     ctx,
     version,
@@ -356,6 +411,7 @@ def release(
     tag_name,
     tag_description,
     allow_dirty,
+    allow_no_changes,
 ):
     """Creates a release for the latest 'unreleased' changes. Use '--modify' to directly modify the changelog file.
     You can automatically use the latest version by using the version keywords 'major', 'minor', 'patch', 'post'
@@ -368,31 +424,11 @@ def release(
     """
     kacl_changelog = load_changelog(ctx)
     kacl_config = kacl_changelog.config
+    raise_on_invalid(kacl_changelog)
 
-    if not kacl_changelog.is_valid():
-        click.echo(
-            click.style("Error: ", fg="red")
-            + "Changelog is not valid. Run 'kacl-cli verify' for more information."
-        )
-        sys.exit(1)
-
-    # check if the version string indicates automatic increment
-    increment = None
-    if version in ["major", "minor", "patch", "post"]:
-        increment = version
-        version = None  # reset
-    else:
-        # check if version is a valid semantic version
-        try:
-            semver.VersionInfo.parse(version)
-        except Exception:
-            click.echo(
-                click.style("Error: ", fg="red")
-                + f'"{version}" not a valid semantic version.'
-            )
-            sys.exit(1)
+    version, increment = check_auto_increment(version)
 
-    if not kacl_changelog.has_changes():
+    if not allow_no_changes and not kacl_changelog.has_changes():
         click.echo(
             click.style("Error: ", fg="red")
             + "The current changelog has no changes. You can only release if changes are available."
@@ -407,7 +443,11 @@ def release(
         auto_link = True
 
     kacl_changelog.release(
-        version=version, link=link, auto_link=auto_link, increment=increment
+        version=version,
+        link=link,
+        auto_link=auto_link,
+        increment=increment,
+        allow_no_changes=allow_no_changes,
     )
 
     # get the new version
@@ -511,13 +551,7 @@ def squash(
     """Squshes all changes from a given version into a single section. Use '--modify' to directly modify the changelog file."""
 
     kacl_changelog = load_changelog(ctx)
-
-    if not kacl_changelog.is_valid():
-        click.echo(
-            click.style("Error: ", fg="red")
-            + "Changelog is not valid. Run 'kacl-cli verify' for more information."
-        )
-        sys.exit(1)
+    raise_on_invalid(kacl_changelog)
 
     if not to_version:
         to_version = kacl_changelog.current_version()

{python-kacl-0.4.6 → python_kacl-0.5.0}/kacl/version.py

@@ -215,7 +215,7 @@ class KACLVersion(KACLElement):
                     KACLValidationError(
                         line=element.raw(),
                         line_number=element.line_number(),
-                        error_message=f'"{title}" is not a valid section for a version. Options are [{",".join( config.allowed_version_sections)}]',
+                        error_message=f'"{title}" is not a valid section for a version. Options are [{",".join(config.allowed_version_sections)}]',
                         start_character_pos=start_pos,
                         end_character_pos=end_pos,
                     )

{python-kacl-0.4.6 → python_kacl-0.5.0/python_kacl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-kacl
-Version: 0.4.6
+Version: 0.5.0
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Home-page: https://gitlab.com/schmieder.matthias/python-kacl.git
 Author: Matthias Schmieder
@@ -14,6 +14,10 @@ Classifier: Topic :: Software Development :: Version Control
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: semver
+Requires-Dist: gitpython
+Requires-Dist: pyyaml
 
 # python-kacl
 
@@ -437,13 +441,12 @@ in order to generate the correct urls, `python-kacl` allows you to define three
 
 ```yaml
 kacl:
-  git:
-    links:
-        # The host url is optional and will be automatically determined using your the git repository. If run on gitlab CI the host will be determined by CI_PROJECT_URL if not specified here.
-        host_url: https://github.com/mschmieder/kacl-cli
-        compare_versions_template: '{host}/compare/v{previous_version}...v{version}'
-        unreleased_changes_template: '{host}/tree/v{latest_version}...HEAD'
-        initial_version_template: '{host}/tree/v{version}'
+  links:
+    # The host url is optional and will be automatically determined using your git repository. If run on gitlab CI the host will be determined by CI_PROJECT_URL if not specified here.
+    host_url: https://github.com/mschmieder/kacl-cli
+    compare_versions_template: '{host}/compare/v{previous_version}...v{version}'
+    unreleased_changes_template: '{host}/compare/v{latest_version}...HEAD'
+    initial_version_template: '{host}/tree/v{version}'
 ```
 
 Using the python format syntax you can generate any links you want. The available replacement variables are `version`, `previous_version`, `host` and `latest_version`.
@@ -550,7 +553,7 @@ kacl:
     tag_name: "v{new_version}"
     tag_description: "Version v{new_version} released"
   links:
-      # The host url is optional and will be automatically determined using your the git repository
+      # The host url is optional and will be automatically determined using your git repository
       # host_url: https://github.com/mschmieder/kacl-cli
       compare_versions_template: '{host}/compare/{previous_version}...{version}'
       unreleased_changes_template: '{host}/compare/{latest_version}...master'
@@ -577,7 +580,7 @@ source ./venv/bin/activate
 pip install -e .
 
 # install development requirements
-pip install -r dev-requirements
+pip install -r dev-requirements.txt
 
 # run the tests
 python3 -m pytest --snapshot-update --allow-snapshot-deletion

{python-kacl-0.4.6 → python_kacl-0.5.0}/setup.py

@@ -11,9 +11,9 @@ this_directory = path.abspath(path.dirname(__file__))
 with open(path.join(this_directory, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
-version = "0.4.6"
+version = "0.5.0"
 
-version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX','')}"
+version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX', '')}"
 
 # read the requirements from requirements.txt
 requirements = []

{python-kacl-0.4.6 → python_kacl-0.5.0}/tests/test_cli.py

@@ -38,6 +38,40 @@ def test_verify_with_json_output():
     assert validation_result["valid"] is False
 
 
+def test_current(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path):
+        result = runner.invoke(
+            cli,
+            [
+                "-f",
+                changelog_file,
+                "current",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        assert result.output == "1.0.0\n"
+
+
+def test_next(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path):
+        result = runner.invoke(
+            cli,
+            ["-f", changelog_file, "next", "patch"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        assert result.output == "1.0.1\n"
+
+
 @freeze_time("2023-01-01")
 def test_release_patch(tmp_path, snapshot):
     runner = CliRunner()

{python-kacl-0.4.6 → python_kacl-0.5.0}/tests/test_kacl.py

@@ -216,6 +216,17 @@ class TestKacl(TestCase):
             "https://gitlab.com/schmieder.matthias/python-kacl.git/-/compare/v1.0.0...HEAD",
         )
 
+    def test_release_with_allow_no_changes_flag(self):
+        changelog_file = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)),
+            "data/CHANGELOG_without_changes.md",
+        )
+        changelog = kacl.load(changelog_file)
+
+        self.assertFalse(changelog.has_changes())
+        changelog.release("1.0.1", allow_no_changes=True)
+        self.assertEqual("1.0.1", changelog.current_version())
+
     def test_release_with_increment(self):
         tests = {
             "major": "2.0.0",
@@ -240,6 +251,7 @@ class TestKacl(TestCase):
 
         for increment, expected_version in fail_tests.items():
             changelog = kacl.load(changelog_file)
+            changelog.config.post_release_version_prefix = None
 
             msg = "This is my first added change"
             changelog.add("Added", msg)
@@ -269,6 +281,28 @@ class TestKacl(TestCase):
             changelog.release(increment=increment)
             self.assertEqual(expected_version, changelog.current_version())
 
+    def test_release_with_increment_extension_hotfix(self):
+        tests = {
+            "major": "2.0.0",
+            "minor": "1.1.0",
+            "patch": "1.0.1",
+            "post": "1.0.0-hotfix.1",
+        }
+        changelog_file = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), "data/CHANGELOG.md"
+        )
+
+        for increment, expected_version in tests.items():
+            changelog = kacl.load(changelog_file)
+            changelog.config.post_release_version_prefix = "hotfix"
+
+            msg = "This is my first added change"
+            changelog.add("Added", msg)
+
+            self.assertTrue(changelog.has_changes())
+            changelog.release(increment=increment)
+            self.assertEqual(expected_version, changelog.current_version())
+
     def test_post_release_with_increment(self):
         tests = {
             "major": "2.0.0",
@@ -282,6 +316,7 @@ class TestKacl(TestCase):
 
         for increment, expected_version in tests.items():
             changelog = kacl.load(changelog_file)
+            changelog.config.post_release_version_prefix = "post"
 
             msg = "This is my first added change"
             changelog.add("Added", msg)