Metadata-Version: 2.1
Name: samsgeneratechangelog
Version: 1.0.3
Summary: Let Sam generate a changelog for you by grouping commits by file, or commit message, or anything!
Home-page: https://github.com/Sam-Martin/sams-generate-changelog
Author: Sam Martin
Author-email: samjackmartin+sams_generate_changelog@gmail.com
License: UNKNOWN
Project-URL: Documentation, https://sams-generate-changelog.readthedocs.io/en/latest/
Description: 
        # Sam's Generate Changelog
        
        ![PyPI](https://img.shields.io/pypi/v/samsgeneratechangelog?style=flat-square)
        ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sam-martin/sams-generate-changelog/Python%20package)
        ![Requires.io](https://img.shields.io/requires/github/Sam-Martin/sams-generate-changelog?style=flat-square)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/samsgeneratechangelog?style=flat-square)
        ![GitHub](https://img.shields.io/github/license/sam-martin/sams-generate-changelog?style=flat-square)
        
        Yet another changelog generator!
        
        Sam’s Generate Changelog focusses on making it easy to group information about your commits by `author_date`, `author`, `file_path`, `friendly_change_type`, and more importantly, custom attributes!
        
        This makes it easy to generate a changelog that’s as simple as a list of all commits/files that changed, or as complicated as a list of Python files changed grouped by module and then grouped by author with their last changed date.
        
        # Documentation
        
        For full documentation go to [ReadTheDocs](https://sams-generate-changelog.readthedocs.io/en/latest/).
        
        # Installation
        
        ```
        pip install samsgeneratechangelog
        ```
        
        # Usage
        
        ## Command
        
        ```
        $ sgc save --start-ref HEAD~3 --end-ref HEAD --var header_text 0.0.1 --output-file CHANGELOG.md --entry-id 0.0.1
        ```
        
        ## Outputs to CHANGELOG.md
        
        ```
        
        [//]: # (SamsGenerateChangelog-0.0.1)
         # 0.0.1
        
         ## Sam Martin's Files
        
        
         ### Added
        
         - tests/fixtures/custom_template.j2 - 2020-09-02 11:26:13
         - tests/test_cmdline_arguments.py - 2020-09-02 11:26:13
        
         ### Modified
        
         - samsgeneratechangelog/__init__.py - 2020-09-02 11:26:13
         - samsgeneratechangelog/__main__.py - 2020-09-02 11:26:13
         - samsgeneratechangelog/config.py - 2020-09-02 11:26:13
         - samsgeneratechangelog/generatechangelog.py - 2020-09-02 11:26:13
         - tests/test_default_templates.py - 2020-09-02 11:26:13
         [//]: # (SamsGenerateChangelog-0.0.1)
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
