{"repo":"Colin-b/keepachangelog","free":true,"listed":false,"github":"https://github.com/Colin-b/keepachangelog","clone":"git clone https://github.com/Colin-b/keepachangelog.git","description":"Convert keep a changelog markdown file into python dict","language":"Python","stars":51,"topics":["changelog","changelog-parser","markdown"],"license":"MIT","category":"cli-tools","readme_excerpt":"Manipulate keep a changelog files Command line utility Convert to dict Convert from dict Release a new version Add changelog retrieval REST API endpoint Starlette Flask-RestX Convert changelog to dict Convert changelog markdown file following keep a changelog format into python dict. changes would look like: For a markdown file with the following content: show unreleased parameter can be specified in order to include Unreleased section information. Note that release date metadata will be set to None in such as case. Retrieving the raw content Using CLI For details on what is actually performed, refer to the section below as it is what is used underneath the hood. Using python module If for some reason you would like to retrieve the raw content of a release you can use to raw dict instead. changes would look like: Convert dict to changelog Convert a python dict (resulting from keepachangelog.to dict ) to a changelog markdown content following keep a changelog format. Release Using CLI For details on what is actually performed, refer to the section below as it is what is used underneath the hood. Using python module You can create a new release by using keepachangelog.release function. This will: If new version parameter is not provided, guess the new version number and return it: Removed or Changed sections will be considered as breaking changes, thus incrementing the major version. If the only section is Fixed , only patch will be incremented. Otherwise, minor will be increme","default_branch":null,"files":null,"tree":[],"storefront":"/r/Colin-b","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Colin-b/keepachangelog/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}