| Name | changelog-keeper JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Command line utility for keeping your changelog tidy |
| upload_time | 2023-04-04 17:52:24 |
| maintainer | |
| docs_url | None |
| author | Jacek Lewański |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Jacek Lewański 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
changelog-generator
changelog-formatter
changelog-parser
keep-a-changelog
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Changelog Keeper
*Command line utility for keeping your changelog tidy*
## About the project
This tool aims to:
1. make your changelog file standardized; and
2. reduce the time spent on updating the changelog file by providing a suite of basic commands.
The Changelog standard is based on the [keep-a-changelog](https://keepachangelog.com/) convention with few adjustments, described in [this document](IMPLEMENTATION_DETAILS.md#changelog-keeper-and-keep-a-changelog-convention).
It is also possible (with some additional scripting/tooling) to incorporate this utility into your *Continuous Integration & Continuous Delivery* routines. There are few things to consider, mentioned in [this document](IMPLEMENTATION_DETAILS.md#cicd-integration-notes).
## Getting started
### Prerequisites
* Python >= 3.7
* Pip
### Installation
```bash
# general installation
pip install changelog-keeper
# with specific version
pip install changelog-keeper==1.0.0
```
## Usage
Changelog Keeper provides five simple commands allowing basic operations on the changelog file:
```bash
# Create new, empty changelog file
clkpr create [-f PATH]
# Add new entry to the changelog file
clkpr add [-f PATH] CHANGE_TYPE ENTRY
# Validate and (if needed and possible) fix the changelog file
clkpr check [-f PATH]
# Release a version (with optional link)
clkpr release [-f PATH] [-r URL] VERSION_NAME
# Yank released version
clkpr yank [-f PATH] VERSION_NAME
# For more details, one can check the help messages for the tool: `clkpr -h`
# and for a particular command: `clkpr <command> -h`
```
## Contributing
Please have a look into [CONTRIBUTING](CONTRIBUTING.md) file for detailed suggestions regarding project contribution.
## License
Distributed under the **MIT License**. See [LICENSE](LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": "",
"name": "changelog-keeper",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "changelog,changelog-generator,changelog-formatter,changelog-parser,keep-a-changelog",
"author": "Jacek Lewa\u0144ski",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8a/1e/2b4b0c41385fdfe09678ec789da0c67b15a1451fd4e19815862bfd3509f9/changelog-keeper-1.0.0.tar.gz",
"platform": null,
"description": "# Changelog Keeper\n\n*Command line utility for keeping your changelog tidy*\n\n## About the project\n\nThis tool aims to:\n\n1. make your changelog file standardized; and\n2. reduce the time spent on updating the changelog file by providing a suite of basic commands.\n\nThe Changelog standard is based on the [keep-a-changelog](https://keepachangelog.com/) convention with few adjustments, described in [this document](IMPLEMENTATION_DETAILS.md#changelog-keeper-and-keep-a-changelog-convention).\n\nIt is also possible (with some additional scripting/tooling) to incorporate this utility into your *Continuous Integration & Continuous Delivery* routines. There are few things to consider, mentioned in [this document](IMPLEMENTATION_DETAILS.md#cicd-integration-notes).\n\n## Getting started\n\n### Prerequisites\n\n* Python >= 3.7\n* Pip\n\n### Installation\n\n```bash\n# general installation\npip install changelog-keeper\n\n# with specific version\npip install changelog-keeper==1.0.0\n```\n\n## Usage\n\nChangelog Keeper provides five simple commands allowing basic operations on the changelog file:\n\n```bash\n# Create new, empty changelog file\nclkpr create [-f PATH]\n\n# Add new entry to the changelog file\nclkpr add [-f PATH] CHANGE_TYPE ENTRY\n\n# Validate and (if needed and possible) fix the changelog file\nclkpr check [-f PATH]\n\n# Release a version (with optional link)\nclkpr release [-f PATH] [-r URL] VERSION_NAME\n\n# Yank released version\nclkpr yank [-f PATH] VERSION_NAME\n\n# For more details, one can check the help messages for the tool: `clkpr -h`\n# and for a particular command: `clkpr <command> -h`\n```\n\n## Contributing\n\nPlease have a look into [CONTRIBUTING](CONTRIBUTING.md) file for detailed suggestions regarding project contribution.\n\n## License\n\nDistributed under the **MIT License**. See [LICENSE](LICENSE) file for more information.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Jacek Lewa\u0144ski 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": "Command line utility for keeping your changelog tidy",
"version": "1.0.0",
"split_keywords": [
"changelog",
"changelog-generator",
"changelog-formatter",
"changelog-parser",
"keep-a-changelog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77fa50d73f08934f51d161f49176c4c1aa1c5ac0f635096eacb0260054323b61",
"md5": "6015381bc290815d58387511f1edb552",
"sha256": "0ec8b4614be97c4cb566f7324a7b040dc6e227e3bcb829efcb2b24234abd093e"
},
"downloads": -1,
"filename": "changelog_keeper-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6015381bc290815d58387511f1edb552",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14002,
"upload_time": "2023-04-04T17:52:22",
"upload_time_iso_8601": "2023-04-04T17:52:22.324262Z",
"url": "https://files.pythonhosted.org/packages/77/fa/50d73f08934f51d161f49176c4c1aa1c5ac0f635096eacb0260054323b61/changelog_keeper-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a1e2b4b0c41385fdfe09678ec789da0c67b15a1451fd4e19815862bfd3509f9",
"md5": "76124d0db4dfd2d6490e387b0c6e7e8a",
"sha256": "d8f0d222de1a31dd9a8dbd91bcbf48059927a6c1f74e6af690b918068199ab4a"
},
"downloads": -1,
"filename": "changelog-keeper-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "76124d0db4dfd2d6490e387b0c6e7e8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 13227,
"upload_time": "2023-04-04T17:52:24",
"upload_time_iso_8601": "2023-04-04T17:52:24.656453Z",
"url": "https://files.pythonhosted.org/packages/8a/1e/2b4b0c41385fdfe09678ec789da0c67b15a1451fd4e19815862bfd3509f9/changelog-keeper-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-04 17:52:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "changelog-keeper"
}
