| Name | changelog-generator JSON |
| Version |
0.7
JSON |
| download |
| home_page | |
| Summary | Python module to, generate well formatted commit notes from git commit history. |
| upload_time | 2023-07-30 17:51:32 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2020 Vignesh Sivanandha 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
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/changelog-generator)
[](https://github.com/thevickypedia/changelog-generator/actions/workflows/pages/pages-build-deployment)
[](https://github.com/thevickypedia/changelog-generator/actions/workflows/python-publish.yml)
[](https://pypi.org/project/changelog-generator/#files)
[](https://pypi.org/project/changelog-generator)
[](https://api.github.com/repos/thevickypedia/changelog-generator)
[](https://api.github.com/repos/thevickypedia/changelog-generator)
[](https://api.github.com/repos/thevickypedia/changelog-generator)
# CHANGELOG generator
Generate CHANGELOG from git commit history
### Installation
```shell
pip install changelog-generator
```
### Usage
###### Regular CHANGELOG
```shell
changelog
```
###### Regular CHANGELOG in debug mode
```shell
changelog debug
```
###### CHANGELOG in reverse order
```shell
changelog reverse
```
###### Flags
- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed
- `-f` Write the commit notes to a custom filename. Defaults to `CHANGELOG`
- `-t` Title or index line for the file generated. Defaults to `Change Log`
#### Sample
[release_notes.rst][release_notes]
### 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/changelog-generator/][pypi]
### Runbook
[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
[https://thevickypedia.github.io/changelog-generator/][runbook]
## License & copyright
© Vignesh Sivanandha Rao, Changelog Generator
Licensed under the [MIT License][license]
[release_notes]: https://github.com/thevickypedia/changelog-generator/blob/main/release_notes.rst
[runbook]: https://thevickypedia.github.io/changelog-generator/
[license]: https://github.com/thevickypedia/changelog-generator/blob/master/LICENSE
[pypi]: https://pypi.org/project/changelog-generator/
Raw data
{
"_id": null,
"home_page": "",
"name": "changelog-generator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "changelog,automate,commits",
"author": "",
"author_email": "Vignesh Sivanandha Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "[](https://pypi.org/project/changelog-generator)\n\n\n[](https://github.com/thevickypedia/changelog-generator/actions/workflows/pages/pages-build-deployment)\n[](https://github.com/thevickypedia/changelog-generator/actions/workflows/python-publish.yml)\n\n[](https://pypi.org/project/changelog-generator/#files)\n[](https://pypi.org/project/changelog-generator)\n\n\n[](https://api.github.com/repos/thevickypedia/changelog-generator)\n[](https://api.github.com/repos/thevickypedia/changelog-generator)\n[](https://api.github.com/repos/thevickypedia/changelog-generator)\n\n# CHANGELOG generator\nGenerate CHANGELOG from git commit history\n\n### Installation\n```shell\npip install changelog-generator\n```\n\n### Usage\n###### Regular CHANGELOG\n```shell\nchangelog\n```\n\n###### Regular CHANGELOG in debug mode\n```shell\nchangelog debug\n```\n\n###### CHANGELOG in reverse order\n```shell\nchangelog reverse\n```\n\n###### Flags\n- `-b` Gather commit notes specific to a branch. Uses `Default branch` if not passed\n- `-f` Write the commit notes to a custom filename. Defaults to `CHANGELOG`\n- `-t` Title or index line for the file generated. Defaults to `Change Log`\n\n#### Sample\n[release_notes.rst][release_notes]\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/changelog-generator/][pypi]\n\n### Runbook\n[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)\n\n[https://thevickypedia.github.io/changelog-generator/][runbook]\n\n## License & copyright\n\n© Vignesh Sivanandha Rao, Changelog Generator\n\nLicensed under the [MIT License][license]\n\n[release_notes]: https://github.com/thevickypedia/changelog-generator/blob/main/release_notes.rst\n[runbook]: https://thevickypedia.github.io/changelog-generator/\n[license]: https://github.com/thevickypedia/changelog-generator/blob/master/LICENSE\n[pypi]: https://pypi.org/project/changelog-generator/\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 Vignesh Sivanandha 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": "Python module to, generate well formatted commit notes from git commit history.",
"version": "0.7",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/changelog-generator/issues",
"Docs": "https://thevickypedia.github.io/changelog-generator/",
"Homepage": "https://github.com/thevickypedia/changelog-generator",
"Release Notes": "https://github.com/thevickypedia/changelog-generator/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/changelog-generator"
},
"split_keywords": [
"changelog",
"automate",
"commits"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "16d0784d0d70fcbf4c726228a3b5888f7346b8bb361c0e4d49217a3d559b4fa2",
"md5": "df531990a352f72b23e298863cdcef42",
"sha256": "a71c826036deeb353de65e70e24b31358c1d7846191c687b9682fd9594e7d06e"
},
"downloads": -1,
"filename": "changelog_generator-0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df531990a352f72b23e298863cdcef42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8442,
"upload_time": "2023-07-30T17:51:32",
"upload_time_iso_8601": "2023-07-30T17:51:32.242494Z",
"url": "https://files.pythonhosted.org/packages/16/d0/784d0d70fcbf4c726228a3b5888f7346b8bb361c0e4d49217a3d559b4fa2/changelog_generator-0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-30 17:51:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "changelog-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "changelog-generator"
}
