Skip to content

Parse and extract information from changelogs that follows the keepachangelog.com format

License

Notifications You must be signed in to change notification settings

rcmachado/pykeepachangelog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pykeepachangelog

Parses changelogs that follows keepachangelog format, exposing the data in a structured way.

Installation

pykeepachangelog supports Python 2.7, 3.5 and 3.6.

$ pip install pykeepachangelog

Usage

import keepachangelog

with open("CHANGELOG.md", "r") as fd:
    keepachangelog.parse_file(fd)

How it works

pykeepachangelog is a wrapper on top of misaka Markdown parser. It expects a file that follows the format specified by Keep a Changelog and returns the information described in a structured way (per version and section).

Contributing

Pull requests are welcomed. Before submiting you code for review, please make sure all the tests passed after your change:

$ pytest

License

This project is licensed under `MIT license`_. For details please see LICENSE file.

About

Parse and extract information from changelogs that follows the keepachangelog.com format

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages