Skip to main content

Python module to, generate CHANGELOG from git commit history.

Project description

Pypi-version Pypi-py-version

docs pypi

Pypi-format Pypi-status

Maintained GitHub Repo created GitHub commit activity GitHub last commit

CHANGELOG generator

Generate CHANGELOG from git commit history

Pypi Module

https://pypi.org/project/changelog-generator/

Usage

pip install changelog-generator

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

© Vignesh Sivanandha Rao, Changelog Generator

Licensed under the MIT License

0.0.1 (08/30/2021 - 18:52:52)

  • Initial commit

0.0.2 (08/30/2021 - 18:57:44)

  • Add basic way to get details from git log

0.0.3 (08/30/2021 - 21:57:30)

  • Get content required for a CHANGELOG

0.0.4 (08/30/2021 - 22:06:24)

  • Add version numbers for each change
  • Rename variable names

0.0.5 (08/30/2021 - 22:09:10)

  • Get the number of commits automatically
  • Add three digit version numbers

0.0.6 (08/30/2021 - 22:26:07)

  • Wrap everything inside a class
  • Print run time at the end

0.0.7 (08/30/2021 - 22:45:15)

  • Get the commit info from the trunk branch
  • Add a destructor method
  • Add docstrings

0.0.8 (08/30/2021 - 22:50:04)

  • Add pre-commit for linting, isort and flake8

0.0.9 (08/30/2021 - 23:07:49)

  • 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 - 23:17:14)

  • onboard docs.yml but only prints a statement

0.1.1 (08/30/2021 - 23:24:27)

  • auto upload to pypi when tagged a release version

0.1.2 (08/30/2021 - 23:59:10)

  • 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 - 00:02:16)

  • revert change on python-publish.yml

0.1.4 (08/31/2021 - 00:03:04)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelog-generator-0.1.5.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

changelog_generator-0.1.5-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file changelog-generator-0.1.5.tar.gz.

File metadata

  • Download URL: changelog-generator-0.1.5.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for changelog-generator-0.1.5.tar.gz
Algorithm Hash digest
SHA256 21f68eb91565b56de15050418777aac81e76f755a8d91fc4f118d917cde2ae55
MD5 3ee73e53bfd4ab851abcc31093295cf1
BLAKE2b-256 eeb5c557ccb4da095bf458fa87e4bfd8ae40a889ab4ba5b18a84f2401ce78fc0

See more details on using hashes here.

File details

Details for the file changelog_generator-0.1.5-py2.py3-none-any.whl.

File metadata

  • Download URL: changelog_generator-0.1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for changelog_generator-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3b770efafafac35e1e75d58e8fe7d312b20d3a75441030b289e72d30407bddd0
MD5 62d2cb032f48a9131c6f949521b57617
BLAKE2b-256 a95f30a4d09880d4cce3b5bbf180710696ae622592919b14c5e70e1c0b010b24

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page