https://github.com/rcmachado/pykeepachangelog
Parse and extract information from changelogs that follows the keepachangelog.com format
https://github.com/rcmachado/pykeepachangelog
Last synced: about 2 months ago
JSON representation
Parse and extract information from changelogs that follows the keepachangelog.com format
- Host: GitHub
- URL: https://github.com/rcmachado/pykeepachangelog
- Owner: rcmachado
- License: mit
- Created: 2017-07-09T22:11:45.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-11T14:21:58.000Z (almost 8 years ago)
- Last Synced: 2025-03-26T06:32:47.564Z (3 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 7
- Watchers: 0
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
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.
.. code-block:: bash
$ pip install pykeepachangelog
Usage
-----
.. code-block:: python
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:
.. code-block:: bash
$ pytest
License
-------
This project is licensed under `MIT license`_. For details please see
`LICENSE` file.
.. _keepachangelog: https://keepachangelog.com
.. _license: https://choosealicense.com/licenses/mit/
.. _misaka: https://github.com/FSX/misaka