Metadata-Version: 2.1
Name: changelog-generator
Version: 0.2.1
Summary: Python module to, generate CHANGELOG from git commit history.
Home-page: https://github.com/thevickypedia/changelog-generator
Author: Vignesh Sivanandha Rao
Author-email: svignesh1793@gmail.com
License: UNKNOWN
Keywords: changelog,commits,automate
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS :: MacOS X
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Version Control :: Git
Description-Content-Type: text/markdown; charset=UTF-8
License-File: LICENSE

[![Pypi-version](https://img.shields.io/pypi/v/changelog-generator)](https://pypi.org/project/changelog-generator)
[![Pypi-py-version](https://img.shields.io/pypi/pyversions/changelog-generator)](https://pypi.org/project/changelog-generator)

![docs](https://github.com/thevickypedia/changelog-generator/actions/workflows/docs.yml/badge.svg)
![pypi](https://github.com/thevickypedia/changelog-generator/actions/workflows/python-publish.yml/badge.svg)

[![Pypi-format](https://img.shields.io/pypi/format/changelog-generator)](https://pypi.org/project/changelog-generator/#files)
[![Pypi-status](https://img.shields.io/pypi/status/changelog-generator)](https://pypi.org/project/changelog-generator)

![Maintained](https://img.shields.io/maintenance/yes/2021)
[![GitHub Repo created](https://img.shields.io/date/1630367571)](https://api.github.com/repos/thevickypedia/changelog-generator)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/changelog-generator)](https://api.github.com/repos/thevickypedia/changelog-generator)
[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/changelog-generator)](https://api.github.com/repos/thevickypedia/changelog-generator)

# CHANGELOG generator
Generate CHANGELOG from git commit history

### Pypi Module
[https://pypi.org/project/changelog-generator/](https://pypi.org/project/changelog-generator/)

### Usage
`pip install changelog-generator`

###### Navigate to the repository, launch a scratch file and run:
```python
from changemaker.generator import Generator

Generator().run()
```

### Pre-Commit
Install `pre-commit` to run `flake8` and `isort` for linting and `sphinx` for documentation generator.

`pip3 install pre-commit sphinx recommonmark`

`pre-commit run --all-files`

### Runbook
https://thevickypedia.github.io/changelog-generator/

## License & copyright

&copy; Vignesh Sivanandha Rao, Changelog Generator

Licensed under the [MIT License](https://github.com/thevickypedia/changelog-generator/blob/master/LICENSE)


Change Log

0.0.1 (08/30/2021)
------------------
- Initial commit

0.0.2 (08/30/2021)
------------------
- Add basic way to get details from `git log`

0.0.3 (08/30/2021)
------------------
- Get content required for a CHANGELOG

0.0.4 (08/30/2021)
------------------
- Add version numbers for each change
- Rename variable names

0.0.5 (08/30/2021)
------------------
- Get the number of commits automatically
- Add three digit version numbers

0.0.6 (08/30/2021)
------------------
- Wrap everything inside a class
- Print run time at the end

0.0.7 (08/30/2021)
------------------
- Get the commit info from the trunk branch
- Add a destructor method
- Add docstrings

0.0.8 (08/30/2021)
------------------
- Add pre-commit for linting, isort and flake8

0.0.9 (08/30/2021)
------------------
- Add sphinx documentation
- README markdown and __init__ support for sphinx documentation
- Create gen_docs.sh
- Hook up the doc generation process to pre-commit

0.1.0 (08/30/2021)
------------------
- onboard docs.yml but only prints a statement

0.1.1 (08/30/2021)
------------------
- auto upload to pypi when tagged a release version

0.1.2 (08/30/2021)
------------------
- Create a pypi package
- Move generator.py within a source directory
- Add __init__.py, CHANGELOT, LICENSE, MANIFEST.in, setup.cfg, setup.py, version.py

0.1.3 (08/31/2021)
------------------
- revert change on python-publish.yml

0.1.4 (08/31/2021)
------------------
- auto upload to pypi when tagged a release version

0.1.5 (08/31/2021)
------------------
- Alter time counter in destructor method
- Update README.md, .gitignore, CHANGELOG
- Bump version

0.1.6 (08/31/2021)
------------------
- Update sample code in README.md
- Bump version to 0.1.6

0.1.7 (08/31/2021)
------------------
- bump version to run build

0.1.8 (08/31/2021)
------------------
- Support up to 6 digit version numbers
- Fix versions() getting called repeatedly
- Add logger info

0.1.9 (08/31/2021)
------------------
- Update CHANGELOG

0.2.0 (08/31/2021)
------------------
- Remove timestamp from CHANGELOG

0.2.1 (10/14/2021)
------------------
- Add title to the generated CHANGELOG


