# simple-git-changelog
[](https://pypi.org/project/simple-git-changelog/)
[](https://pypi.org/project/simple-git-changelog/)
[](https://github.com/craigahobbs/simple-git-changelog/blob/main/LICENSE)
[](https://pypi.org/project/simple-git-changelog/)
**simple-git-changelog** is a command-line tool for creating and updating a git project's changelog
file.
## Links
- [Source code](https://github.com/craigahobbs/simple-git-changelog)
## Create the Changelog File
To create your project's changelog file, run simple-git-changelog in your project's root directory:
~~~ sh
$ simple-git-changelog
~~~
By default, the "CHANGELOG.md" file is created with your project's changes. For example:
~~~ markdown
# Changelog
## 2021-04-30
- [abcdf0](https://github.com/username/project-name/commit/abcdf0) most recent change
- [abcdef](https://github.com/username/project-name/commit/abcdef) previous change
~~~
Edit "CHANGELOG.md" as appropriate and commit. Changes to the changelog title are maintained across
updates.
## Update the Changelog File
To update your changelog file, simply run simple-git-changelog again. Change items for new git
changes are added to the top of the changelog:
~~~ markdown
# MyProject Changelog
## 2021-05-01
- [abcdf1](https://github.com/username/project-name/commit/abcdf1) one more thing
## 2021-04-30
- [abcdf0](https://github.com/username/project-name/commit/abcdf0) most recent change
- [abcdef](https://github.com/username/project-name/commit/abcdef) previous change
~~~
## Usage
~~~
usage: simple-git-changelog [-h] [-o FILE]
options:
-h, --help show this help message and exit
-o FILE specify the change log file (default is "CHANGELOG.md")
~~~
## Development
This package is developed using [python-build](https://github.com/craigahobbs/python-build#readme).
It was started using [python-template](https://github.com/craigahobbs/python-template#readme) as follows:
~~~
template-specialize python-template/template/ simple-git-changelog/ -k package simple-git-changelog -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1
~~~
Raw data
{
"_id": null,
"home_page": "https://github.com/craigahobbs/simple-git-changelog",
"name": "simple-git-changelog",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "git,changelog",
"author": "Craig A. Hobbs",
"author_email": "craigahobbs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9b/98/b95ca559d0f6499d89f03564113769c8c97ef32e53b162f8b16b37c93f05/simple-git-changelog-1.1.2.tar.gz",
"platform": null,
"description": "# simple-git-changelog\n\n[](https://pypi.org/project/simple-git-changelog/)\n[](https://pypi.org/project/simple-git-changelog/)\n[](https://github.com/craigahobbs/simple-git-changelog/blob/main/LICENSE)\n[](https://pypi.org/project/simple-git-changelog/)\n\n**simple-git-changelog** is a command-line tool for creating and updating a git project's changelog\nfile.\n\n\n## Links\n\n- [Source code](https://github.com/craigahobbs/simple-git-changelog)\n\n\n## Create the Changelog File\n\nTo create your project's changelog file, run simple-git-changelog in your project's root directory:\n\n~~~ sh\n$ simple-git-changelog\n~~~\n\nBy default, the \"CHANGELOG.md\" file is created with your project's changes. For example:\n\n~~~ markdown\n# Changelog\n\n## 2021-04-30\n\n- [abcdf0](https://github.com/username/project-name/commit/abcdf0) most recent change\n\n- [abcdef](https://github.com/username/project-name/commit/abcdef) previous change\n~~~\n\nEdit \"CHANGELOG.md\" as appropriate and commit. Changes to the changelog title are maintained across\nupdates.\n\n\n## Update the Changelog File\n\nTo update your changelog file, simply run simple-git-changelog again. Change items for new git\nchanges are added to the top of the changelog:\n\n~~~ markdown\n# MyProject Changelog\n\n## 2021-05-01\n\n- [abcdf1](https://github.com/username/project-name/commit/abcdf1) one more thing\n\n## 2021-04-30\n\n- [abcdf0](https://github.com/username/project-name/commit/abcdf0) most recent change\n\n- [abcdef](https://github.com/username/project-name/commit/abcdef) previous change\n~~~\n\n\n## Usage\n\n~~~\nusage: simple-git-changelog [-h] [-o FILE]\n\noptions:\n -h, --help show this help message and exit\n -o FILE specify the change log file (default is \"CHANGELOG.md\")\n~~~\n\n\n## Development\n\nThis package is developed using [python-build](https://github.com/craigahobbs/python-build#readme).\nIt was started using [python-template](https://github.com/craigahobbs/python-template#readme) as follows:\n\n~~~\ntemplate-specialize python-template/template/ simple-git-changelog/ -k package simple-git-changelog -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1\n~~~\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple git changelog file generator",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/craigahobbs/simple-git-changelog"
},
"split_keywords": [
"git",
"changelog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a754890bf60059c45cefb9ed9621fec27b388f07b149d36a5fee585cb8329348",
"md5": "f604492e58bb4c59c0f5829921ba30c9",
"sha256": "7a566c6a4d9465c67c1b4a6f08a857c729d1dd3ec7ae2e603322abb1bb3bbb3c"
},
"downloads": -1,
"filename": "simple_git_changelog-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f604492e58bb4c59c0f5829921ba30c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5276,
"upload_time": "2023-06-28T14:31:15",
"upload_time_iso_8601": "2023-06-28T14:31:15.869927Z",
"url": "https://files.pythonhosted.org/packages/a7/54/890bf60059c45cefb9ed9621fec27b388f07b149d36a5fee585cb8329348/simple_git_changelog-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b98b95ca559d0f6499d89f03564113769c8c97ef32e53b162f8b16b37c93f05",
"md5": "993b16ce30498eabf3a94f8e1d65469e",
"sha256": "30e9f611e47ecd81edebac4bb653a1cf919c73585dff37471c619c7a0a5a8067"
},
"downloads": -1,
"filename": "simple-git-changelog-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "993b16ce30498eabf3a94f8e1d65469e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4198,
"upload_time": "2023-06-28T14:31:17",
"upload_time_iso_8601": "2023-06-28T14:31:17.222029Z",
"url": "https://files.pythonhosted.org/packages/9b/98/b95ca559d0f6499d89f03564113769c8c97ef32e53b162f8b16b37c93f05/simple-git-changelog-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-28 14:31:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "craigahobbs",
"github_project": "simple-git-changelog",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "simple-git-changelog"
}
JSON
