{"id":16135624,"url":"https://github.com/thevickypedia/gitverse","last_synced_at":"2025-12-14T09:41:43.599Z","repository":{"id":57417100,"uuid":"401517623","full_name":"thevickypedia/gitverse","owner":"thevickypedia","description":"Generate a well formatted RST/MarkDown file from git releases or commit messages","archived":false,"fork":false,"pushed_at":"2025-10-13T21:28:10.000Z","size":340,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-03T19:51:05.880Z","etag":null,"topics":["commit-message-formatter","gitverse","release-notes-generateor"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/gitverse/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thevickypedia.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-30T23:52:51.000Z","updated_at":"2025-10-13T21:28:14.000Z","dependencies_parsed_at":"2024-04-10T00:37:09.090Z","dependency_job_id":"61d2d7e0-dbe9-4bd3-aed5-fb0812b2625b","html_url":"https://github.com/thevickypedia/gitverse","commit_stats":{"total_commits":57,"total_committers":2,"mean_commits":28.5,"dds":0.01754385964912286,"last_synced_commit":"e4b50914a9b2c3ddc964ba992aef27906e297cef"},"previous_names":["thevickypedia/changelog-generator"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/thevickypedia/gitverse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2Fgitverse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2Fgitverse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2Fgitverse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2Fgitverse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thevickypedia","download_url":"https://codeload.github.com/thevickypedia/gitverse/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thevickypedia%2Fgitverse/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27725058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commit-message-formatter","gitverse","release-notes-generateor"],"created_at":"2024-10-09T23:08:47.218Z","updated_at":"2025-12-14T09:41:43.555Z","avatar_url":"https://github.com/thevickypedia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Pypi-version](https://img.shields.io/pypi/v/gitverse)](https://pypi.org/project/gitverse)\n![Python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)\n\n[![pages-build-deployment](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment)\n[![pypi-publish](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml/badge.svg)](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)\n\n[![Pypi-format](https://img.shields.io/pypi/format/gitverse)](https://pypi.org/project/gitverse/#files)\n[![Pypi-status](https://img.shields.io/pypi/status/gitverse)](https://pypi.org/project/gitverse)\n\n![Maintained](https://img.shields.io/maintenance/yes/2023)\n[![GitHub Repo created](https://img.shields.io/date/1630367571)](https://api.github.com/repos/thevickypedia/gitverse)\n[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)\n[![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse)\n\n# GitVerse\nGet GitHub's release notes or commit history and format it into `reStructuredText`/`Markdown` documents.\n\n### Installation\n```shell\npip install gitverse\n```\n\n### Usage\n#### Release Notes (Tags)\nGenerate release notes from releases tagged in GitHub\n```shell\ngitverse-release\n```\n\n\u003e Tries to get release notes, using GitHub API\u003cbr\u003e\n\u003e If failed, uses the commit message as notes for the associated release\u003cbr\u003e\n\u003e This feature optionally takes `GIT_TOKEN` as an environment variable if it is generated for a personal repo\u003cbr\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eKnown issue related to the order of release notes\u003c/strong\u003e\u003c/summary\u003e\n\n- There is a known issue with GitHub where the `git tag` command returns incorrect timestamp _(when tags are created in different timezones)_\n- If the release notes are not generated in the expected order, please run the following command to verify\n```shell\ngit for-each-ref --sort='-creatordate' --format '%(refname:short) %(creatordate:iso8601)' refs/tags\n```\n- If the output is in expected order, please raise an [issue](https://github.com/thevickypedia/gitverse/issues/new)\n\u003c/details\u003e\n\n---\n\n#### Commit History\nGenerate commit history from git log\n```shell\ngitverse-commit\n```\n\n---\n\n#### Options\n- `debug` - Enable debug mode for logging.\n- `reverse` - Generate commit history/release notes in reverse order.\n\n#### Flags\n- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed. (Only for `gitverse-commit`)\n- `-f` Write the commit notes to a custom filename.\n- `-t` Title or index line for the file generated.\n\n#### Sample\n[release_notes.rst][release_notes]\n\n[changelog.rst][changelog]\n\n### Linting\n`PreCommit` will ensure linting, and the doc creation are run on every commit.\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit==2.20.0 recommonmark==0.7.1\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)](https://packaging.python.org/tutorials/packaging-projects/)\n\n[https://pypi.org/project/gitverse/][pypi]\n\n### Runbook\n[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)\n\n[https://thevickypedia.github.io/gitverse/][runbook]\n\n## License \u0026 copyright\n\n\u0026copy; Vignesh Rao, GitVerse\n\nLicensed under the [MIT License][license]\n\n[release_notes]: https://github.com/thevickypedia/gitverse/blob/main/release_notes.rst\n[changelog]: https://github.com/thevickypedia/gitverse/blob/main/changelog.rst\n[runbook]: https://thevickypedia.github.io/gitverse/\n[license]: https://github.com/thevickypedia/gitverse/blob/master/LICENSE\n[pypi]: https://pypi.org/project/gitverse/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthevickypedia%2Fgitverse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthevickypedia%2Fgitverse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthevickypedia%2Fgitverse/lists"}