Metadata-Version: 2.1
Name: whathappened
Version: 0.1.1
Summary: A changelog generator using simply structured git commit messages.
Home-page: https://github.com/Rollcloud/whathappened
Author: Rollcloud
Author-email: roullcloud@gmail.com
License: UNKNOWN
Description: [![GitHub license](https://img.shields.io/github/license/Rollcloud/whathappened)](https://github.com/Rollcloud/whathappened/blob/main/LICENSE)
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Rollcloud/whathappened/test-build?logo=github)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/whathappened?logo=pypi)
        ![semver](https://img.shields.io/badge/semver-2.0.0-blue)
        ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/rollcloud/whathappened?sort=semver)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        # whathappened
        A changelog generator using simply structured git commit messages
        
        ## Inspired by
        
        * [SemVer](https://semver.org/)
        * [Angular Commit Message Format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit)
        * [Auto Changelog](https://github.com/Michael-F-Bryan/auto-changelog)
        * [git_commits.py](https://gist.github.com/simonw/091b765a071d1558464371042db3b959#file-get_commits-py)
        
        ## Install and Run
        
        Installation is as simple as it gets:
        
            pip install whathappened
        
        ~~To generate a changelog, run:~~
        
            $ whathappened
        
        Make sure to activate any virtual envrionment that you might be using first.
        
        ## Package Changelog
        
        Created by Whathappened itself - very meta.
        
        For the complete changelog, please see [CHANGELOG.md](CHANGELOG.md).
        
        ## Whathappened Commit Message Format
        
        Whathappened expects git commit messages in the format outlined below:
        
            [optional breaking ]<type>[ optional (<scope>)]: <description>
        
            [optional body]
        
        `<type>` is recommended to be one of:
        
            fix
            feat
            build
            chore
            ci
            docs
            style
            refactor
            perf
            test
        
        `<scope>` is recommended to be a module, file, or folder name as appropiate.
        
        This is a simpler version of https://www.conventionalcommits.org/
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
