Metadata-Version: 2.1
Name: python-changelog
Version: 0.2.0
Summary: A module that generates changelogs based on git tags.
Home-page: UNKNOWN
Author: Lennart Suwe
Author-email: lennsa999@gmx.de
License: UNKNOWN
Description: # Changelog Generator
        
        A module that generates changelogs based on git tags.
        It uses conventional commits (https://www.conventionalcommits.org) to read and scope commits.
        Markdown is used for formating.
        
        ## Commands
        
        **$ pychangelog generate [\<path>] [--types=\<list>] [--bodytags=\<list>]**
        * generates new CHANGELOG.md file at repo root
        * overrides old CHANGELOG.md
        
        **$ pychangelog add [\<path>] [--types=\<list>] [--bodytags=\<list>]**
        * ceeps the content of the old CHANGELOG.md while adding new version logs
        
        **$ pychangelog printout [\<path>] [--types=\<list>] [--bodytags=\<list>]**
        * prints the generated changelog in terminal instead of writing it in the CHANGELOG.md
        * does not touch the CHANGELOG.md
        
        ## Options
        
        Option | Format | Description | Default
        --- | --- | --- | ---
        path | TEXT | path to root of the git repository | .
        --types | TEXT comma seperated list | commit types to show in changelog | feat,fix,chore,docs,refactor,test
        --bodytags | TEXT comma seperated list | body tags that schould be shown in changelog | BREAKING CHANGE,MAJOR
        
        ## Instalation
        
        You can install the changelog generator via PyPI:
        
        `pip install python-changelog`
        
Keywords: changelog conventional commit git
Platform: UNKNOWN
Description-Content-Type: text/markdown
