README.md

Changelog generator

Generates readme file from yaml source files to prevent merge conflicts.

Inspired by GitLab's solution

Usage

Install required dependencies globally or in virtual environment

$ python -m pip install -r requirements.txt 

$ python main.py -h
usage: main.py [-h] [-d] [-o] [--dry-run] [--version]

Generate changelog

optional arguments:
  -h, --help      show this help message and exit
  -d              input directory
  -o , --output   output directory
  --dry-run       doesn't write or comit anything, just print to output
  --version, -v   show program's version number and exit

To generate readme from provided test data run

python main.py -d ./test_data/changelog/