| Name | yaclog JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Yet another changelog CLI tool. |
| upload_time | 2024-04-16 06:51:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
changelog
commandline
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Yaclog
[](https://yaclog.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml)
[](https://badge.fury.io/py/yaclog)
Yet another changelog command line tool
*Logo by Erin Cassidy*
## Installation
Install and update using [pip](https://pip.pypa.io/en/stable/quickstart/):
```shell
$ pip install -U yaclog
```
## Usage
For usage from the command line, yaclog provides the `yaclog` command:
```
Usage: yaclog [OPTIONS] COMMAND [ARGS]...
Manipulate markdown changelog files.
Options:
--path FILE Location of the changelog file. [default: CHANGELOG.md]
--version Show the version and exit.
--help Show this message and exit.
Commands:
entry Add entries to the changelog.
format Reformat the changelog file.
init Create a new changelog file.
release Release versions.
show Show changes from the changelog file
tag Modify version tags
```
### Example workflow
Create a new changelog:
```shell
$ yaclog init
```
Add some new entries to the "Added" section of the current unreleased version:
```shell
$ yaclog entry -b 'Introduced some more bugs'
$ yaclog entry -b 'Introduced some more features'
```
Show the current version:
```shell
$ yaclog show
```
```
Unreleased
- Introduced some more bugs
- Introduced some more features
```
Release the current version and make a git tag for it
```shell
$ yaclog release 0.0.1 -c
```
```
Renamed version "Unreleased" to "0.0.1".
Commit and create tag for version 0.0.1? [y/N]: y
Created commit a7b6789
Created tag "0.0.1".
```
Raw data
{
"_id": null,
"home_page": null,
"name": "yaclog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "changelog, commandline, markdown",
"author": null,
"author_email": "Andrew Cassidy <drewcassidy@me.com>",
"download_url": "https://files.pythonhosted.org/packages/89/4a/8d8c1f86941365283f4de5b8acd658f29e03a744521b28e51f0257fbdb8b/yaclog-1.2.0.tar.gz",
"platform": null,
"description": "# Yaclog \n\n[](https://yaclog.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml)\n[](https://badge.fury.io/py/yaclog)\n\nYet another changelog command line tool\n\n\n\n*Logo by Erin Cassidy*\n\n## Installation\n\nInstall and update using [pip](https://pip.pypa.io/en/stable/quickstart/):\n\n```shell\n$ pip install -U yaclog\n```\n\n## Usage\n\nFor usage from the command line, yaclog provides the `yaclog` command:\n```\nUsage: yaclog [OPTIONS] COMMAND [ARGS]...\n\n Manipulate markdown changelog files.\n\nOptions:\n --path FILE Location of the changelog file. [default: CHANGELOG.md]\n --version Show the version and exit.\n --help Show this message and exit.\n\nCommands:\n entry Add entries to the changelog.\n format Reformat the changelog file.\n init Create a new changelog file.\n release Release versions.\n show Show changes from the changelog file\n tag Modify version tags\n```\n\n### Example workflow\n\nCreate a new changelog:\n```shell\n$ yaclog init\n```\n\nAdd some new entries to the \"Added\" section of the current unreleased version:\n```shell\n$ yaclog entry -b 'Introduced some more bugs'\n$ yaclog entry -b 'Introduced some more features'\n```\n\nShow the current version:\n\n```shell\n$ yaclog show\n```\n```\nUnreleased\n\n- Introduced some more bugs\n- Introduced some more features\n```\n\nRelease the current version and make a git tag for it\n\n```shell\n$ yaclog release 0.0.1 -c\n```\n```\nRenamed version \"Unreleased\" to \"0.0.1\".\nCommit and create tag for version 0.0.1? [y/N]: y\nCreated commit a7b6789\nCreated tag \"0.0.1\".\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Yet another changelog CLI tool.",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/drewcassidy/yaclog/blob/main/CHANGELOG.md",
"Docs": "https://yaclog.readthedocs.io/",
"Source": "https://github.com/drewcassidy/yaclog"
},
"split_keywords": [
"changelog",
" commandline",
" markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c04bb8e8a7b0e67d11a19ba091ae82be19c8a8a39ae172850b39ebae001c17e",
"md5": "3d469f03694682b3eb68a98df67e054b",
"sha256": "330f7fa1e7cb76c00861bf43598a250ab6ad764bbb71996fae6387feb5efabd2"
},
"downloads": -1,
"filename": "yaclog-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d469f03694682b3eb68a98df67e054b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27819,
"upload_time": "2024-04-16T06:51:13",
"upload_time_iso_8601": "2024-04-16T06:51:13.878601Z",
"url": "https://files.pythonhosted.org/packages/0c/04/bb8e8a7b0e67d11a19ba091ae82be19c8a8a39ae172850b39ebae001c17e/yaclog-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "894a8d8c1f86941365283f4de5b8acd658f29e03a744521b28e51f0257fbdb8b",
"md5": "35eeb7eac7ce02005d6fe1d3c57818e8",
"sha256": "e7fa799dff6aab2dee2f5f1637828cdaeaeefdadf76aa2caaa765309ba921f40"
},
"downloads": -1,
"filename": "yaclog-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "35eeb7eac7ce02005d6fe1d3c57818e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 91232,
"upload_time": "2024-04-16T06:51:16",
"upload_time_iso_8601": "2024-04-16T06:51:16.339472Z",
"url": "https://files.pythonhosted.org/packages/89/4a/8d8c1f86941365283f4de5b8acd658f29e03a744521b28e51f0257fbdb8b/yaclog-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 06:51:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "drewcassidy",
"github_project": "yaclog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "yaclog"
}
