https://github.com/alexanderad/tiny-changelog

Tiny Changelog Generator
https://github.com/alexanderad/tiny-changelog

Last synced: 3 months ago
JSON representation

Tiny Changelog Generator

• Host: GitHub
• URL: https://github.com/alexanderad/tiny-changelog
• Owner: alexanderad
• License: mit
• Created: 2017-04-23T08:17:52.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-14T07:54:04.000Z (over 7 years ago)
• Last Synced: 2025-02-19T17:46:44.701Z (3 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: changelog/__init__.py
  • License: LICENSE

Awesome Lists containing this project

README

        
Tiny Changelog

==============

.. image:: https://img.shields.io/pypi/v/tiny-changelog.svg

    :target: https://pypi.python.org/pypi/tiny-changelog

Yet another approach to generate simple and slim CHANGELOG file.

Install

-------

.. code-block:: bash

    pip install tiny-changelog

Usage

-----

.. code-block:: bash

    usage: tiny-changelog [-h] [-t TOKEN] -p PROJECT [-s START_DATE] [-o OUTPUT]

                          [--with-unreleased]

    Generate CHANGELOG file.

    optional arguments:

      -h, --help            show this help message and exit

      -t TOKEN, --token TOKEN

                            Github token

      -p PROJECT, --project PROJECT

                            Github project (/)

      -s START_DATE, --start-date START_DATE

                            List entries starting as early as YYYY-MM-DD

      -o OUTPUT, --output OUTPUT

                            Output file, defaults to CHANGELOG.md

      --with-unreleased     Include unreleased merged pull requests