Git Product home page Git Product logo

pykeepachangelog's Introduction

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.

pykeepachangelog's People

Contributors

rcmachado avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.