GitVerse

Get GitHub's release notes or commit history and format it into reStructuredText/Markdown documents.

Installation

pip install gitverse

Usage

Release Notes (Tags)

Generate release notes from releases tagged in GitHub

gitverse-release

Tries to get release notes, using GitHub API
If failed, uses the commit message as notes for the associated release
This feature optionally takes GIT_TOKEN as an environment variable if it is generated for a personal repo

Known issue related to the order of release notes

There is a known issue with GitHub where the git tag command returns incorrect timestamp (when tags are created in different timezones)
If the release notes are not generated in the expected order, please run the following command to verify

git for-each-ref --sort='-creatordate' --format '%(refname:short) %(creatordate:iso8601)' refs/tags

If the output is in expected order, please raise an issue

Commit History

Generate commit history from git log

gitverse-commit

Options

debug - Enable debug mode for logging.
reverse - Generate commit history/release notes in reverse order.

Flags

-b Gather commit notes specific to a branch. Uses Default branch if not passed. (Only for gitverse-commit)
-f Write the commit notes to a custom filename.
-t Title or index line for the file generated.

Sample

release_notes.rst

changelog.rst

Linting

PreCommit will ensure linting, and the doc creation are run on every commit.

Requirement

pip install sphinx==5.1.1 pre-commit==2.20.0 recommonmark==0.7.1

Usage

pre-commit run --all-files

Pypi Package

https://pypi.org/project/gitverse/

Runbook

https://thevickypedia.github.io/gitverse/

License & copyright

Licensed under the MIT License

Metadata

Release files for gitverse 3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for gitverse 3.3
File	Interpreter	ABI	Platform	Reset
gitverse-3.3-py3-none-any.whl 13.8 kB Oct 13, 2025	Python 3	none	any	Details

Release files / gitverse-3.3-py3-none-any.whl

Download URL	gitverse-3.3-py3-none-any.whl
Size	13.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`751de4059e986ce57ea639b4f3616be61c3bad6d4992bf662b0901268c608721`
BLAKE2b-256 checksum How to use checksums	`e0f9bde1e560ec87ee9c6ecaac848fbd673f1cbb0f7d665dc1c2d6a3eed8a192`
Upload date	Oct 13, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.11.13`