keepachangelog | Convert keep a changelog markdown file into python dict

by Colin-b Python Version: 2.0.0.dev5 License: MIT

X-Ray Key Features Code Snippets(3)Community Discussions(3)Vulnerabilities Install Support

kandi X-RAY | keepachangelog Summary

keepachangelog is a Python library typically used in Utilities applications. keepachangelog has no bugs, it has no vulnerabilities, it has build file available, it has a Permissive License and it has low support. You can install using 'pip install keepachangelog' or download it from GitHub, PyPI.

Convert keep a changelog markdown file into python dict

Support

Quality

Security

License

Reuse

Support

keepachangelog has a low active ecosystem.

It has 23 star(s) with 7 fork(s). There are 2 watchers for this library.

There were 1 major release(s) in the last 6 months.

There are 2 open issues and 13 have been closed. On average issues are closed in 29 days. There are 1 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of keepachangelog is 2.0.0.dev5

Quality

keepachangelog has no bugs reported.

Security

keepachangelog has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

License

keepachangelog is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

keepachangelog releases are available to install and integrate.

Deployable package is available in PyPI.

Build file is available. You can build the component from source.

Installation instructions, examples and code snippets are available.

Top functions reviewed by kandi - BETA

kandi has reviewed keepachangelog and discovered the below as its top functions. This is intended to give you an instant insight into keepachangelog implemented functionality, and help decide if they suit your requirements.

Return the release of the given changelog
Bump the patch
Bump minor
Bump the major
Guess the release version from the given changelog
Bump the semantic version
Return a sorted list of versions sorted by semantic order
Add new version link to changelog
Add changelog endpoint
Parse the change log into a dict
Extract date from a date string
Convert a version string to a semantic version
Convert changelog into a dict
Add a release line
Compute the semantic order of two semantic versions
Compares two strings
Convert a changelog file into a dict

Get all kandi verified functions for this library.

keepachangelog Key Features

No Key Features are available at this moment for keepachangelog.

keepachangelog Examples and Code Snippets

Convert changelog to dict

Python

Lines of Code : 118

License : Permissive (MIT)

Copy

import keepachangelog

changes = keepachangelog.to_dict("path/to/CHANGELOG.md")

changes = {
    "1.1.0": {
        "changed": [
            "Enhancement 1 (1.1.0)",
            "sub enhancement 1",
            "sub enhancement 2",
            "Enhan

Convert changelog to dict,Retrieving the raw content

Python

Lines of Code : 60

License : Permissive (MIT)

Copy

import keepachangelog

changes = keepachangelog.to_raw_dict("path/to/CHANGELOG.md")

changes = {
    "1.1.0": {
        "raw": """### Changed
- Enhancement 1 (1.1.0)
 - sub enhancement 1
 - sub enhancement 2
- Enhancement 2 (1.1.0)""",
        "metad

Endpoint,Flask-RestX

Python

Lines of Code : 9

License : Permissive (MIT)

Copy

import flask
import flask_restx
from keepachangelog.flask_restx import add_changelog_endpoint


app = flask.Flask(__name__)
api = flask_restx.Api(app)
# /changelog endpoint will return the dict extracted from the changelog as JSON.
add_changelog_endp

Community Discussions

Trending Discussions on keepachangelog

How to follow Semantic Versioning and Keep a Changelog conventions together?

How to have different markdownlint rules for CHANGELOG.md files

grep split and match

QUESTION

How to follow Semantic Versioning and Keep a Changelog conventions together?

Asked 2021-Apr-29 at 20:07

Keep a Changelog is a wide-used convention that brings some guidelines about the maintenance of a CHANGELOG.md file in repositories managed over a VCS.

I'm in doubt about how should it work when it comes of multiple commits of a unique release. Since its text describes that "The same types of changes should be grouped" and its own repo CHANGELOG.md file brings the following:

...

ANSWER

Answered 2021-Apr-29 at 20:07

So I understand that each commit that introduces a bug-fix or a new feature should increase the PATCH or MINOR version respectively.

That is NOT true. There can be many commits leading up to a version bump. You bump the version when you publish your changes, not when you commit them. Note that for some workflows, "official" builds (run on the CI/CD systems) implies publication.

Source https://stackoverflow.com/questions/67170089

QUESTION

How to have different markdownlint rules for CHANGELOG.md files

Asked 2020-Dec-11 at 14:40

In VS Code, I use markdownlint for my markdown files. I like the rules that it imposes except for my CHANGELOG.md file (see keepachangelog.com).

Is there a way to have one set of rules for most of my markdown files and another set for the change log?

...

ANSWER

Answered 2020-Dec-11 at 14:40

You can use custom markdownlint configuration for a file by using the following syntax:

Source https://stackoverflow.com/questions/65218768

QUESTION

grep split and match

Asked 2020-Jul-30 at 20:12

I need to parse a CHANGELOG in Keep a changelog format with grep (or awk, etc in shell/bash) and get the last version (the first one after [Unreleased] tag).

It means, split this file with block '\n## ', ignore the first ([Unreleased]) and get the second (if exists).

With nodeJS, it's very easy and readable CHANGELOG.split(/\n## /)[2]; But I can't make it work with grep ... grep -zoP -m 1 "(\n## .*)(\n## .*)?(\n## )?" CHANGELOG.md

I can't make the regex match group with multiline even using (.|\n)+ Since I'm on it since few days and trying again and again, the Machine Learning found this ##(?:[^be]+[^#]*###)+[^#]* but, it looks like too heavy for just "block split with \n## ".

...

ANSWER

Answered 2020-Jul-29 at 09:27

Ed can do this.

Source https://stackoverflow.com/questions/63148815

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install keepachangelog

python 3.6+ must be installed
Use pip to install module:

Support

For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .

Find more information at: