Metadata-Version: 2.1
Name: yaclog
Version: 1.0.3
Summary: Yet another changelog CLI tool.
Home-page: UNKNOWN
Author: Andrew Cassidy
License: AGPLv3
Project-URL: Source, https://github.com/drewcassidy/yaclog
Project-URL: Changelog, https://github.com/drewcassidy/yaclog/blob/main/CHANGELOG.md
Project-URL: Docs, https://yaclog.readthedocs.io/
Description: # Yaclog 
        
        [![Documentation Status](https://readthedocs.org/projects/yaclog/badge/?version=latest)](https://yaclog.readthedocs.io/en/latest/?badge=latest)
        [![Build Status](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml/badge.svg)](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml)
        [![PyPI version](https://badge.fury.io/py/yaclog.svg)](https://badge.fury.io/py/yaclog)
        
        Yet another changelog command line tool
        
        ![a yak who is a log](https://github.com/drewcassidy/yaclog/raw/main/logo.png)
        
        *Logo by Erin Cassidy*
        
        ## Installation
        
        Install and update using [pip](https://pip.pypa.io/en/stable/quickstart/):
        
        ```shell
        $ pip install -U yaclog
        ```
        
        ## Usage
        
        For usage from the command line, yaclog provides the `yaclog` command:
        ```
        Usage: yaclog [OPTIONS] COMMAND [ARGS]...
        
          Manipulate markdown changelog files.
        
        Options:
          --path FILE  Location of the changelog file.  [default: CHANGELOG.md]
          --version    Show the version and exit.
          --help       Show this message and exit.
        
        Commands:
          entry    Add entries to the changelog.
          format   Reformat the changelog file.
          init     Create a new changelog file.
          release  Release versions.
          show     Show changes from the changelog file
          tag      Modify version tags
        ```
        
        ### Example workflow
        
        Create a new changelog:
        ```shell
        $ yaclog init
        ```
        
        Add some new entries to the "Added" section of the current unreleased version:
        ```shell
        $ yaclog entry -b 'Introduced some more bugs'
        $ yaclog entry -b 'Introduced some more features'
        ```
        
        Show the current version:
        
        ```shell
        $ yaclog show
        ```
        ```
        Unreleased
        
        - Introduced some more bugs
        - Introduced some more features
        ```
        
        Release the current version and make a git tag for it
        
        ```shell
        $ yaclog release 0.0.1 -c
        ```
        ```
        Renamed version "Unreleased" to "0.0.1".
        Commit and create tag for version 0.0.1? [y/N]: y
        Created commit a7b6789
        Created tag "0.0.1".
        ```
        
Keywords: changelog,commandline,markdown
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: docs
