changelog-notes 0.1.0__py3-none-any.whl

changelog_notes-0.1.0.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: changelog-notes
+Version: 0.1.0
+Summary: Extract the notes for one version from CHANGELOG.md (for GitHub releases) and validate the format. Stdlib only.
+Author-email: agent-one <rafal.baranowski.iot@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/rafal-one/changelog-notes
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# changelog-notes
+
+Pull the release notes for one version out of a Keep-a-Changelog style `CHANGELOG.md`, and
+validate the file. Handy in CI to fill a GitHub release body. Stdlib only, Python 3.9+.
+
+```
+pip install changelog-notes
+changelog-notes 1.2.0 > notes.md      # notes for v1.2.0 (leading "v" optional)
+changelog-notes                       # latest released version (skips Unreleased)
+changelog-notes --list                # versions and dates
+changelog-notes --check               # exit 1 on missing dates, empty or duplicate sections
+```
+
+Options: `-f FILE` (default `CHANGELOG.md`). Exit codes: 0 ok, 1 not found / check failed, 2 file unreadable.
+Headings like `## [1.2.0] - 2026-01-01` and `## v1.2.0 - 2026-01-01` are understood; link
+reference footers (`[1.2.0]: https://...`) are dropped from the output.
+
+GitHub Actions example: `gh release create "$TAG" -F <(changelog-notes "$TAG")`.
+
+## Support
+If this saves you time: https://paypal.me/RafalBaranowski
+
+MIT licensed.

changelog_notes-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+changelog_notes.py,sha256=Vusk6Z4PQRYqfzt5VJh0zNDruk4RRYt2AFzlBwMSc_0,3041
+changelog_notes-0.1.0.dist-info/licenses/LICENSE,sha256=-hZriFiksFsGGM2WbhdnQzoXUOFuMGve5P3y4pvA0Ws,1066
+changelog_notes-0.1.0.dist-info/METADATA,sha256=9hN4Ycc_7F2Bq6L7eIBFl0fb3RRODkAiyQ-ecR1ydt4,1515
+changelog_notes-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+changelog_notes-0.1.0.dist-info/entry_points.txt,sha256=e267WEf8BMhOguUFhsEBXxGBlaTRzF20bkpcfJXYdiM,57
+changelog_notes-0.1.0.dist-info/top_level.txt,sha256=CS2mK9VNvtLXlQ41HRRc-OFUMdXtwpRBt5xGIQjwm64,16
+changelog_notes-0.1.0.dist-info/RECORD,,

changelog_notes-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

changelog_notes-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+changelog-notes = changelog_notes:main

changelog_notes-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 agent-one
+
+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 this 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.

changelog_notes-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+changelog_notes

changelog_notes.py

@@ -0,0 +1,96 @@
+"""Extract and validate release notes from a Keep-a-Changelog style CHANGELOG.md."""
+import argparse
+import re
+import sys
+
+__version__ = "0.1.0"
+
+HEAD = re.compile(r"^##\s+\[?v?([^\]\s]+)\]?(?:\s*[-–—]\s*(\S.*))?\s*$")
+DATE = re.compile(r"^\d{4}-\d{2}-\d{2}$")
+
+
+def parse(text):
+    """Return list of (version, date_or_None, body) in file order."""
+    out, cur = [], None
+    for line in text.splitlines():
+        m = HEAD.match(line)
+        if m:
+            if cur:
+                out.append(cur)
+            ver = m.group(1)
+            date = (m.group(2) or "").strip() or None
+            cur = [ver, date, []]
+        elif cur is not None:
+            if re.match(r"^\[[^\]]+\]:\s*\S+", line):  # link reference footer
+                continue
+            cur[2].append(line)
+    if cur:
+        out.append(cur)
+    return [(v, d, "\n".join(b).strip("\n")) for v, d, b in out]
+
+
+def get(entries, version):
+    version = version.lstrip("v")
+    for v, d, b in entries:
+        if v.lower() == version.lower():
+            return v, d, b
+    return None
+
+
+def validate(entries):
+    problems = []
+    if not entries:
+        return ["no '## [version]' sections found"]
+    seen = set()
+    for v, d, b in entries:
+        if v.lower() in seen:
+            problems.append(f"duplicate version {v}")
+        seen.add(v.lower())
+        if v.lower() == "unreleased":
+            continue
+        if d is None:
+            problems.append(f"{v}: missing date")
+        elif not DATE.match(d.split()[0]):
+            problems.append(f"{v}: date '{d}' is not YYYY-MM-DD")
+        if not b.strip():
+            problems.append(f"{v}: empty section")
+    return problems
+
+
+def main(argv=None):
+    p = argparse.ArgumentParser(prog="changelog-notes", description=__doc__)
+    p.add_argument("version", nargs="?", help="print notes for this version (default: latest released)")
+    p.add_argument("-f", "--file", default="CHANGELOG.md")
+    p.add_argument("--check", action="store_true", help="validate the changelog format")
+    p.add_argument("--list", action="store_true", help="list versions")
+    p.add_argument("-V", "--tool-version", action="version", version=__version__)
+    a = p.parse_args(argv)
+    try:
+        with open(a.file, encoding="utf-8") as f:
+            text = f.read()
+    except OSError as e:
+        print(f"changelog-notes: {e}", file=sys.stderr)
+        return 2
+    entries = parse(text)
+    if a.check:
+        probs = validate(entries)
+        for x in probs:
+            print(f"{a.file}: {x}")
+        return 1 if probs else 0
+    if a.list:
+        for v, d, _ in entries:
+            print(v + (f"  {d}" if d else ""))
+        return 0
+    if a.version:
+        hit = get(entries, a.version)
+    else:
+        hit = next(((v, d, b) for v, d, b in entries if v.lower() != "unreleased"), None)
+    if not hit:
+        print(f"changelog-notes: version {a.version or '(latest)'} not found", file=sys.stderr)
+        return 1
+    print(hit[2])
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())