python-kacl 0.6.1__tar.gz → 0.6.3__tar.gz

{python_kacl-0.6.1/python_kacl.egg-info → python_kacl-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.1
+Version: 0.6.3
 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
@@ -19,6 +19,17 @@ Requires-Dist: semver
 Requires-Dist: gitpython
 Requires-Dist: pyyaml
 Requires-Dist: jira
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # python-kacl
 

{python_kacl-0.6.1 → python_kacl-0.6.3}/kacl/__init__.py

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

{python_kacl-0.6.1 → python_kacl-0.6.3}/kacl/document.py

@@ -27,6 +27,7 @@ class KACLDocument:
         headers=None,
         versions=None,
         link_references=None,
+        meta_data=None,
         config=KACLConfig(),
     ):
         self.__data = data
@@ -35,6 +36,7 @@ class KACLDocument:
         self.__link_references = link_references
         if not self.__link_references:
             self.__link_references = dict()
+        self.__meta_data = meta_data
         self.config = config
 
     def validate(self):
@@ -561,6 +563,14 @@ class KACLDocument:
         """
         return self.__versions
 
+    def metadata(self):
+        """Returns the metadata as dict or None if not available
+
+        Returns:
+            [dict|None] -- metadata of the document
+        """
+        return self.__meta_data
+
     @staticmethod
     def init():
         return KACLDocument.parse(
@@ -591,6 +601,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
             data_lf
         )
 
+        meta_data = KACLParser.parse_metadata(data_lf)
+
         changelog_body = data_lf
         if link_reference_begin:
             changelog_body = data_lf[:link_reference_begin]
@@ -611,6 +623,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
             headers=headers,
             versions=versions,
             link_references=link_references,
+            meta_data=meta_data,
         )
 
     def __get_link_provider(
@@ -652,6 +665,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
                         "ERROR: Could not determine project url. Update your config or run within a valid git repository"
                     )
 
+        host_url = host_url.removesuffix(".git")
+
         return LinkProvider(
             host_url=host_url,
             compare_versions_template=compare_versions_template,

{python_kacl-0.6.1 → python_kacl-0.6.3}/kacl/parser.py

@@ -1,5 +1,7 @@
 import re
 
+import yaml
+
 from kacl.element import KACLElement
 
 
@@ -67,3 +69,12 @@ class KACLParser:
         m = re.search(regex, text)
         if m:
             return m.group().strip()
+
+    @staticmethod
+    def parse_metadata(text):
+        meta_data_parts = text.split("---")
+
+        if not text.startswith("---") or len(meta_data_parts) < 3:
+            return None
+
+        return yaml.safe_load(meta_data_parts[1])

{python_kacl-0.6.1 → python_kacl-0.6.3}/kacl/serializer.py

@@ -1,3 +1,5 @@
+import yaml
+
 from kacl.changes import KACLChanges
 from kacl.document import KACLDocument
 from kacl.element import KACLElement
@@ -10,10 +12,14 @@ class KACLMarkdownSerializer:
 
     def serialize(self, document):
         if isinstance(document, KACLDocument):
-            data = [
-                self.__serialize_header(document.header()),
-                document.header().body(),
-            ]
+            data = []
+
+            serialized_metadata = self.__serialize_metadata(document.metadata())
+            if serialized_metadata:
+                data.extend(serialized_metadata)
+
+            data.append(self.__serialize_header(document.header()))
+            data.append(document.header().body())
 
             link_references = []
             for version in document.versions():
@@ -30,6 +36,17 @@ class KACLMarkdownSerializer:
         elif isinstance(document, KACLVersion):
             return self.__serialize_version(document)
 
+    def __serialize_metadata(self, metadata):
+        if not metadata:
+            return None
+
+        metadata_lines = ["---"]
+        metadata_lines.extend(yaml.dump(metadata).rstrip().split("\n"))
+
+        metadata_lines.append("---")
+
+        return metadata_lines
+
     def __serialize_header(self, obj):
         if isinstance(obj, KACLChanges):
             return f"### {obj.title()}"

{python_kacl-0.6.1 → python_kacl-0.6.3}/kacl/version.py

@@ -149,7 +149,7 @@ class KACLVersion(KACLElement):
                         line_number=self.line_number(),
                         start_character_pos=start_pos,
                         end_character_pos=end_pos,
-                        error_message=")Version is not a valid semantic version.",
+                        error_message="Version is not a valid semantic version.",
                     )
                 )
         return errors

{python_kacl-0.6.1 → python_kacl-0.6.3/python_kacl.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.1
+Version: 0.6.3
 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
@@ -19,6 +19,17 @@ Requires-Dist: semver
 Requires-Dist: gitpython
 Requires-Dist: pyyaml
 Requires-Dist: jira
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # python-kacl
 

{python_kacl-0.6.1 → python_kacl-0.6.3}/setup.py

@@ -11,7 +11,7 @@ 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.6.1"
+version = "0.6.3"
 
 version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX', '')}"
 

{python_kacl-0.6.1 → python_kacl-0.6.3}/tests/test_kacl.py

@@ -444,3 +444,36 @@ def test_get_issues(tmp_path):
 
     issues = changelog.get_associated_issues(version=changelog.current_version())
     assert len(issues["jira"]) == 5
+
+
+def test_simple_metadata(tmp_path):
+    changelog_file = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)),
+        "data/CHANGELOG_with_simple_metadata.md",
+    )
+    changelog = kacl.load(changelog_file)
+    assert changelog.is_valid()
+
+    changelog.release(increment="major")
+
+    content = kacl.dump(changelog)
+
+    assert "---\ntitle: CHANGELOG\n---\n" in str(content)
+
+
+def test_complex_metadata(tmp_path):
+    changelog_file = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)),
+        "data/CHANGELOG_with_complex_metadata.md",
+    )
+    changelog = kacl.load(changelog_file)
+    assert changelog.is_valid()
+
+    changelog.release(increment="major")
+
+    content = kacl.dump(changelog)
+
+    assert (
+        "---\nlist:\n- entry1\n- additional: true\n  key: value\ntitle: CHANGELOG\n---\n"
+        in str(content)
+    )