| Name | gitverse JSON |
| Version |
3.1
JSON |
| download |
| home_page | |
| Summary | Get GitHub's release notes or commit history and format it into `reStructuredText`/`Markdown` documents. |
| upload_time | 2023-12-01 14:41:53 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2020 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
changelog
automate
commits
releases
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/gitverse)
[](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment)
[](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)
[](https://pypi.org/project/gitverse/#files)
[](https://pypi.org/project/gitverse)
[](https://api.github.com/repos/thevickypedia/gitverse)
[](https://api.github.com/repos/thevickypedia/gitverse)
[](https://api.github.com/repos/thevickypedia/gitverse)
# GitVerse
Get GitHub's release notes or commit history and format it into `reStructuredText`/`Markdown` documents.
### Installation
```shell
pip install gitverse
```
### Usage
#### Release Notes (Tags)
Generate release notes from releases tagged in GitHub
```shell
gitverse-release
```
> Tries to get release notes, using GitHub API<br>
> If failed, uses the commit message as notes for the associated release<br>
> This feature optionally takes `GIT_TOKEN` as an environment variable if it is generated for a personal repo<br>
<details>
<summary><strong>Known issue related to the order of release notes</strong></summary>
- 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
```shell
git for-each-ref --sort='-creatordate' --format '%(refname:short) %(creatordate:iso8601)' refs/tags
```
- If the output is in expected order, please raise an [issue](https://github.com/thevickypedia/gitverse/issues/new)
</details>
---
#### Commit History
Generate commit history from git log
```shell
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][release_notes]
[changelog.rst][changelog]
### Linting
`PreCommit` will ensure linting, and the doc creation are run on every commit.
**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit==2.20.0 recommonmark==0.7.1
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[](https://packaging.python.org/tutorials/packaging-projects/)
[https://pypi.org/project/gitverse/][pypi]
### Runbook
[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
[https://thevickypedia.github.io/gitverse/][runbook]
## License & copyright
© Vignesh Rao, GitVerse
Licensed under the [MIT License][license]
[release_notes]: https://github.com/thevickypedia/gitverse/blob/main/release_notes.rst
[changelog]: https://github.com/thevickypedia/gitverse/blob/main/changelog.rst
[runbook]: https://thevickypedia.github.io/gitverse/
[license]: https://github.com/thevickypedia/gitverse/blob/master/LICENSE
[pypi]: https://pypi.org/project/gitverse/
Raw data
{
"_id": null,
"home_page": "",
"name": "gitverse",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "changelog,automate,commits,releases",
"author": "",
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "[](https://pypi.org/project/gitverse)\n\n\n[](https://github.com/thevickypedia/gitverse/actions/workflows/pages/pages-build-deployment)\n[](https://github.com/thevickypedia/gitverse/actions/workflows/python-publish.yml)\n\n[](https://pypi.org/project/gitverse/#files)\n[](https://pypi.org/project/gitverse)\n\n\n[](https://api.github.com/repos/thevickypedia/gitverse)\n[](https://api.github.com/repos/thevickypedia/gitverse)\n[](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> Tries to get release notes, using GitHub API<br>\n> If failed, uses the commit message as notes for the associated release<br>\n> This feature optionally takes `GIT_TOKEN` as an environment variable if it is generated for a personal repo<br>\n\n<details>\n<summary><strong>Known issue related to the order of release notes</strong></summary>\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</details>\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[](https://packaging.python.org/tutorials/packaging-projects/)\n\n[https://pypi.org/project/gitverse/][pypi]\n\n### Runbook\n[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)\n\n[https://thevickypedia.github.io/gitverse/][runbook]\n\n## License & copyright\n\n© 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",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 Vignesh Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Get GitHub's release notes or commit history and format it into `reStructuredText`/`Markdown` documents.",
"version": "3.1",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/gitverse/issues",
"Docs": "https://thevickypedia.github.io/gitverse/",
"Homepage": "https://github.com/thevickypedia/gitverse",
"Release Notes": "https://github.com/thevickypedia/gitverse/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/gitverse"
},
"split_keywords": [
"changelog",
"automate",
"commits",
"releases"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c436f690577d17ebe607db8c7a2ba0ada83b4f26af4cb6ea6daf8498a5b424fd",
"md5": "dbcb0bc95874e861956436791fb4eac1",
"sha256": "f50cb7e7020e388547b14322c99e2b5f49568f50117fd64905314b0e28cfa82e"
},
"downloads": -1,
"filename": "gitverse-3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbcb0bc95874e861956436791fb4eac1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13573,
"upload_time": "2023-12-01T14:41:53",
"upload_time_iso_8601": "2023-12-01T14:41:53.968826Z",
"url": "https://files.pythonhosted.org/packages/c4/36/f690577d17ebe607db8c7a2ba0ada83b4f26af4cb6ea6daf8498a5b424fd/gitverse-3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 14:41:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "gitverse",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gitverse"
}
