Name | clup JSON |
Version |
0.1.0
JSON |
| download |
home_page | None |
Summary | None |
upload_time | 2024-06-15 06:28:27 |
maintainer | None |
docs_url | None |
author | Almaz Ilaletdinov |
requires_python | <4.0,>=3.9 |
license | None |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Clup (Change log upper)
[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)
[![PyPI version](https://badge.fury.io/py/clup.svg)](https://badge.fury.io/py/clup)
![CI status](https://github.com/blablatdinov/clup/actions/workflows/pr-check.yml/badge.svg?branch=master)
[![Lines of code](https://tokei.rs/b1/github/blablatdinov/clup)](https://github.com/XAMPPRocky/tokei_rs)
[![Hits-of-Code](https://hitsofcode.com/github/blablatdinov/clup)](https://hitsofcode.com/github/blablatdinov/clup/view)
This Python script updates a CHANGELOG.md file by adding a new version entry with the specified version number and date.
## Features:
- Adds a new version entry under the "Unreleased" section.
- Updates the link for the "Unreleased" section to point to the new version.
- Generates a comparison link for the new version against the previous one.
## Installation
```bash
pip install clup
```
## Usage
To run the script, use the following command:
```bash
python script.py <path_to_changelog> <new_version> <release_date>
```
Arguments:
- <path_to_changelog>: Path to the CHANGELOG.md file. (Default: CHANGELOG.md)
- <new_version>: New version number to be added. (e.g., 1.0.1)
- <release_date>: Release date for the new version. (e.g., 2024-06-15)
Example
```bash
python script.py CHANGELOG.md 1.0.1 2024-06-15
```
This command will update the CHANGELOG.md file by adding an entry for version 1.0.1 with the release date 2024-06-15.
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "clup",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Almaz Ilaletdinov",
"author_email": "a.ilaletdinov@yandex.ru",
"download_url": "https://files.pythonhosted.org/packages/4b/10/d1223ce11a280aad8696c2e93d7a238e34540e6914ea79a2b69eef807e78/clup-0.1.0.tar.gz",
"platform": null,
"description": "# Clup (Change log upper)\n\n[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)\n[![PyPI version](https://badge.fury.io/py/clup.svg)](https://badge.fury.io/py/clup)\n![CI status](https://github.com/blablatdinov/clup/actions/workflows/pr-check.yml/badge.svg?branch=master)\n[![Lines of code](https://tokei.rs/b1/github/blablatdinov/clup)](https://github.com/XAMPPRocky/tokei_rs)\n[![Hits-of-Code](https://hitsofcode.com/github/blablatdinov/clup)](https://hitsofcode.com/github/blablatdinov/clup/view)\n\nThis Python script updates a CHANGELOG.md file by adding a new version entry with the specified version number and date.\n\n## Features:\n\n- Adds a new version entry under the \"Unreleased\" section.\n- Updates the link for the \"Unreleased\" section to point to the new version.\n- Generates a comparison link for the new version against the previous one.\n\n## Installation\n\n```bash\npip install clup\n```\n\n## Usage\n\nTo run the script, use the following command:\n\n```bash\npython script.py <path_to_changelog> <new_version> <release_date>\n```\n\nArguments:\n\n- <path_to_changelog>: Path to the CHANGELOG.md file. (Default: CHANGELOG.md)\n- <new_version>: New version number to be added. (e.g., 1.0.1)\n- <release_date>: Release date for the new version. (e.g., 2024-06-15)\n\nExample\n\n```bash\npython script.py CHANGELOG.md 1.0.1 2024-06-15\n```\n\nThis command will update the CHANGELOG.md file by adding an entry for version 1.0.1 with the release date 2024-06-15.\n\n## License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01ae4fc2f0127e9c0fe620f554fa1905bc414eaa218b0c5102107f28949a4093",
"md5": "f9bec081c88eb36403fcf2951b3f4890",
"sha256": "2ac12ee195e9c7f0eb40e21aebb5a507e663c3a906d8f36b4416611b01c633cb"
},
"downloads": -1,
"filename": "clup-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9bec081c88eb36403fcf2951b3f4890",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5071,
"upload_time": "2024-06-15T06:28:25",
"upload_time_iso_8601": "2024-06-15T06:28:25.923011Z",
"url": "https://files.pythonhosted.org/packages/01/ae/4fc2f0127e9c0fe620f554fa1905bc414eaa218b0c5102107f28949a4093/clup-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b10d1223ce11a280aad8696c2e93d7a238e34540e6914ea79a2b69eef807e78",
"md5": "3b5aa28456df7726fcd2f95cd9adba71",
"sha256": "66498036633d7020526cfb938926c484f9ec5e4acdfd9afed51df3e2bcd462fd"
},
"downloads": -1,
"filename": "clup-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3b5aa28456df7726fcd2f95cd9adba71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3809,
"upload_time": "2024-06-15T06:28:27",
"upload_time_iso_8601": "2024-06-15T06:28:27.450760Z",
"url": "https://files.pythonhosted.org/packages/4b/10/d1223ce11a280aad8696c2e93d7a238e34540e6914ea79a2b69eef807e78/clup-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-15 06:28:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "clup"
}