# 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.
## 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": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "git, changelog",
"author": "Craig A. Hobbs",
"author_email": "craigahobbs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/c4/3feff0877ae57f3bbbaba0ac2853a62de9df5435a2dfd4eba4b52fa9bf86/simple_git_changelog-1.1.3.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## 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.3",
"project_urls": {
"Homepage": "https://github.com/craigahobbs/simple-git-changelog"
},
"split_keywords": [
"git",
" changelog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c46b427ee4eaa0f004b25d8a44ab8cdbd7e85bb7005711a13221fa8b5a397f8",
"md5": "1f9854e3e60837f2b622c9805b82102f",
"sha256": "7013219f4e23072f29a04099f3e009e3f197846e1e1e19b5e6990180162395ac"
},
"downloads": -1,
"filename": "simple_git_changelog-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f9854e3e60837f2b622c9805b82102f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5161,
"upload_time": "2024-10-02T17:03:01",
"upload_time_iso_8601": "2024-10-02T17:03:01.338985Z",
"url": "https://files.pythonhosted.org/packages/5c/46/b427ee4eaa0f004b25d8a44ab8cdbd7e85bb7005711a13221fa8b5a397f8/simple_git_changelog-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ac43feff0877ae57f3bbbaba0ac2853a62de9df5435a2dfd4eba4b52fa9bf86",
"md5": "f74dd803c5599be81252448a0cbe03d1",
"sha256": "a531051c996b99dcb50a6cba44e8336aaa3296b2a14b8d041ec9ff7e492fe0ef"
},
"downloads": -1,
"filename": "simple_git_changelog-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "f74dd803c5599be81252448a0cbe03d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4138,
"upload_time": "2024-10-02T17:03:02",
"upload_time_iso_8601": "2024-10-02T17:03:02.262040Z",
"url": "https://files.pythonhosted.org/packages/7a/c4/3feff0877ae57f3bbbaba0ac2853a62de9df5435a2dfd4eba4b52fa9bf86/simple_git_changelog-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 17:03:02",
"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
