Easy Changelog
==============
Python version
--------------
Install this repository from Pypi:
```sh
pip install ezchlog
```
Or any other means (`pipx` or a package manager).
Python 3.9+ required.
Rust version
------------
Compile the `ezchlog` rust binary (you should have `rustc`, `cargo` and `upx` available):
```sh
make release
```
Or download a pre-compiled version from [releases](https://gitlab.com/jrdasm/ezchlog/-/releases).
Don’t forget to download the checksum file and check for corruption.
You should rename the binary to `ezchlog` and place it on your PATH.
After installation
------------------
Then you’ll have a command to handle your logs:
```sh
ezchlog --help
```
Add a changelog
---------------
```sh
$ ezchlog add "New url for example API"
_CHANGELOGS/Changed/new_url_for_example_api.md
$ ezchlog add "Fix example API" Fixed 142
_CHANGELOGS/Fixed/142_fix_example_api.md
```
List changelogs
---------------
```sh
$ ezchlog list
Fixed/142_fix_example_api.md
Changed/new_url_for_example_api.md
```
Merge changelogs
----------------
```sh
$ ezchlog merge 1.2.3
$ cat CHANGELOG.md
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## 1.2.3
### Fixed
- Fix example API (142)
### Changed
- New url for example API
```
Configuration
-------------
The following configuration parameters could be specified as environment variables or in a `.ezchlog.toml` file (or `pyproject.toml` file for the python version).
- `EZCHLOG_EDITOR` default to `EDITOR` or `vim`
- `EZCHLOG_LOG_DIR` default to `_CHANGELOGS`
- `EZCHLOG_LOG_FILE` default to `CHANGELOG.md`
- `EZCHLOG_CATEGORY_LIST` default to `Security,Fixed,Changed,Added,Remove,Deprecated`
- `EZCHLOG_CATEGORY_DEFAULT` default to `Changed`
- `EZCHLOG_DEFAULT_CHANGELOG` default to
```
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
```
For `.ezchlog.toml` or `pyproject.toml`, use the env var name in lowercase without the `EZCHLOG` prefix, for instance `log_dir`.
Raw data
{
"_id": null,
"home_page": null,
"name": "ezchlog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "changelog, easy, git, no-conflict, release-notes",
"author": null,
"author_email": "Cyrille Pontvieux <cyrille@enialis.net>",
"download_url": "https://files.pythonhosted.org/packages/f6/95/3c075dbd2faeb7f67a0b47de0018ffb3f02b87f251537ff4b01cbda891b8/ezchlog-0.1.0.tar.gz",
"platform": null,
"description": "Easy Changelog\n==============\n\nPython version\n--------------\n\nInstall this repository from Pypi:\n```sh\npip install ezchlog\n```\nOr any other means (`pipx` or a package manager). \nPython 3.9+ required.\n\nRust version\n------------\n\nCompile the `ezchlog` rust binary (you should have `rustc`, `cargo` and `upx` available):\n```sh\nmake release\n```\n\nOr download a pre-compiled version from [releases](https://gitlab.com/jrdasm/ezchlog/-/releases).\n\nDon\u2019t forget to download the checksum file and check for corruption. \nYou should rename the binary to `ezchlog` and place it on your PATH.\n\nAfter installation\n------------------\n\nThen you\u2019ll have a command to handle your logs:\n```sh\nezchlog --help\n```\n\nAdd a changelog\n---------------\n\n```sh\n$ ezchlog add \"New url for example API\"\n_CHANGELOGS/Changed/new_url_for_example_api.md\n$ ezchlog add \"Fix example API\" Fixed 142\n_CHANGELOGS/Fixed/142_fix_example_api.md\n```\n\nList changelogs\n---------------\n\n```sh\n$ ezchlog list\nFixed/142_fix_example_api.md\nChanged/new_url_for_example_api.md\n```\n\nMerge changelogs\n----------------\n\n```sh\n$ ezchlog merge 1.2.3\n$ cat CHANGELOG.md\n# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)\nand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n\n\n## 1.2.3\n### Fixed\n- Fix example API (142)\n### Changed\n- New url for example API\n```\n\nConfiguration\n-------------\n\nThe following configuration parameters could be specified as environment variables or in a `.ezchlog.toml` file (or `pyproject.toml` file for the python version).\n\n- `EZCHLOG_EDITOR` default to `EDITOR` or `vim`\n- `EZCHLOG_LOG_DIR` default to `_CHANGELOGS`\n- `EZCHLOG_LOG_FILE` default to `CHANGELOG.md`\n- `EZCHLOG_CATEGORY_LIST` default to `Security,Fixed,Changed,Added,Remove,Deprecated`\n- `EZCHLOG_CATEGORY_DEFAULT` default to `Changed`\n- `EZCHLOG_DEFAULT_CHANGELOG` default to \n```\n# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)\nand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n```\n\nFor `.ezchlog.toml` or `pyproject.toml`, use the env var name in lowercase without the `EZCHLOG` prefix, for instance `log_dir`.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Easy git branch friendly changelogs",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://gitlab.com/jrdasm/ezchlog/-/issues",
"Changelog": "https://gitlab.com/jrdasm/ezchlog/-/blob/master/CHANGELOG.md",
"Contributing": "https://gitlab.com/jrdasm/ezchlog/-/blob/master/CONTRIBUTING.md",
"Documentation": "https://gitlab.com/jrdasm/ezchlog/-/blob/master/README.md",
"Merge Requests": "https://gitlab.com/jrdasm/ezchlog/-/merge_requests",
"Repository": "https://gitlab.com/jrdasm/ezchlog"
},
"split_keywords": [
"changelog",
" easy",
" git",
" no-conflict",
" release-notes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "17db5d9523bc08e05a96a06b5574e88c0cdf3a480d2a81d56b782fda77d16197",
"md5": "7f0b1825b1ed2cc0b2d45a16faa0b0d4",
"sha256": "01bc0aea844dbab33dc8aab5864a21c3b6bc4b9b1d1b9a8f7948d5a6e414d2a8"
},
"downloads": -1,
"filename": "ezchlog-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f0b1825b1ed2cc0b2d45a16faa0b0d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9698,
"upload_time": "2024-10-29T03:28:36",
"upload_time_iso_8601": "2024-10-29T03:28:36.909983Z",
"url": "https://files.pythonhosted.org/packages/17/db/5d9523bc08e05a96a06b5574e88c0cdf3a480d2a81d56b782fda77d16197/ezchlog-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6953c075dbd2faeb7f67a0b47de0018ffb3f02b87f251537ff4b01cbda891b8",
"md5": "d0a168a9081f7995f9d8bb7872749431",
"sha256": "82e95e46ab36090aeeea50f23295190cbe4fe5c8e8a2c0c403ed20a28d55ae7d"
},
"downloads": -1,
"filename": "ezchlog-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d0a168a9081f7995f9d8bb7872749431",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 43078,
"upload_time": "2024-10-29T03:28:38",
"upload_time_iso_8601": "2024-10-29T03:28:38.200638Z",
"url": "https://files.pythonhosted.org/packages/f6/95/3c075dbd2faeb7f67a0b47de0018ffb3f02b87f251537ff4b01cbda891b8/ezchlog-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 03:28:38",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "jrdasm",
"gitlab_project": "ezchlog",
"lcname": "ezchlog"
}
JSON