Metadata-Version: 2.1
Name: changelogfromtags
Version: 0.2.1
Summary: Generate a changelog from git tags.
Home-page: https://gitlab.com/cdlr75/changelogfromtags
Author: cdlr75
Author-email: cdlr75@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://gitlab.com/cdlr75/changelogfromtags/issues
Project-URL: Source, https://gitlab.com/cdlr75/changelogfromtags/
Description: changelogfromtags ![Git Logo](images/git.png)
        [![pipeline status](https://gitlab.com/cdlr75/changelogfromtags/badges/master/pipeline.svg)](https://gitlab.com/cdlr75/changelogfromtags/commits/master)
        [![PEP8](https://img.shields.io/badge/code%20style-pep8-green.svg)](https://www.python.org/dev/peps/pep-0008/)
        [![Downloads](https://pepy.tech/badge/changelogfromtags)](https://pepy.tech/project/changelogfromtags)
        ===
        
        ### Changelog generation has never been so easy
        
        **Fully automated changelog generation** - This package generates a changelog file based on **git tags**.
        
        Since you don't have to fill your `CHANGELOG.md` manually now: just run the script, relax and take a cup of :coffee: before your next release! :tada:
        
        ### *What’s the point of a changelog?*
        
        To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.
        
        ### *Why should I care?*
        
        Because software tools are for _people_. "Changelogs make it easier for users and
        contributors to see precisely what notable changes have been made between each
        release (or version) of the project."
        
        → *[https://keepachangelog.com](https://keepachangelog.com)*
        
        ## Installation
        
        Install the python package like:
        
            $ pip install changelogfromtags
        
        
        ## Usage
        
        Assuming you have a message for git tags:
        ```
        $ git tag -l -n200
        0.1.0           First release
            You retrieve the content of `git tag 0.1.0 -n200`
        0.1.1           Deploy package changelogfromtags on pypi
        ```
        
        ### Running with CLI:
        
        ```
        $ changelogfromtags
        Change Log
        ==========
        
        0.1.1 (06/01/2020)
        ------------------
        Deploy package changelogfromtags on pypi
        
        0.1.0 (06/01/2020)
        ------------------
        First release
        You retrieve the content of `git tag 0.1.0 -n200`
        ```
        
        **To add a prefix on entries if not present:**
        ```
        $ changelogfromtags --prefix "- "
        Change Log
        ==========
        
        0.1.1 (06/01/2020)
        ------------------
        - Deploy package changelogfromtags on pypi
        
        0.1.0 (06/01/2020)
        ------------------
        - First release
        - You retrieve the content of `git tag 0.1.0 -n200`
        ```
        
        ### Running with Docker
        
        TBA
        
        ## Output example
        
        - Look at **[CHANGELOG.md](https://cdlr75.gitlab.io/changelogfromtags/CHANGELOG.html)** for this project
        
        
        ## Features and advantages of this project
        
        - Changelog entries are directly taken from git tags messages
        - No requirements except python and git
        - Generate canonical, neat changelog file, with default sections that follow [basic changelog guidelines](http://keepachangelog.com)
        
        
        ### Alternatives
        
        Here is a [wikipage list of alternatives](https://github.com/github-changelog-generator/Github-Changelog-Generator/wiki/Alternatives) that I found. But none satisfied my requirements.
        
        *If you know other projects, feel free to edit this Wiki page!*
        
        
        ## License
        
        changelogfromtags is released under the [MIT License](http://www.opensource.org/licenses/MIT).
        
        
Keywords: sample setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3
Description-Content-Type: text/markdown
