changelogbump


Namechangelogbump JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryA CLI tool to manage project versioning and changelogs with Keep a Changelog compliance.
upload_time2025-08-09 03:56:56
maintainerNone
docs_urlNone
authorAndrew Galloway
requires_python>=3.11
licenseMIT
keywords changelog versioning semantic cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # changelogbump

[![Python](https://img.shields.io/badge/python3-555555?style=for-the-badge&logo=python&logoColor=ffdd54)](https://www.python.org)
[![Poetry](https://img.shields.io/badge/Poetry-555555?style=for-the-badge&logo=Poetry)](https://python-poetry.org/)
![PyPI - Version](https://img.shields.io/pypi/v/ChangelogBump?style=for-the-badge&logo=PyPi&logoColor=EEEEEE&color=blue)


A command-line tool that updates a project's changelog and bumps its semantic version according to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) conventions.

## Features

- Initializes a new CHANGELOG.md file with a standard header.
- Increments the project version (major, minor, or patch) and updates:
  - The pyproject.toml version.
  - The changelog, prompting for added, changed, or removed entries.
- Helps maintain strict adherence to semantic versioning.

## Requirements

- pyproject.toml

## Installation

1. Ensure you have Python 3.11 or newer installed.
2. Install via pip:
   ```bash
   pip install changelogbump
   ```

## Usage

From your terminal, run:

- Initialize a fresh changelog in the project root (if not present):
  ```bash
  changelogbump init
  ```

- Add and bump your version, specifying the part to increment:
  ```bash
  changelogbump add --major
  changelogbump add --minor
  changelogbump add --patch
  ```

- Provide a summary for the version:
  ```bash
  changelogbump add --patch --summary "Small bug fixes"
  ```

- Check the currently installed version of changelogbump:
  ```bash
  changelogbump version
  ```

You will be prompted for items to add under different sections (Added, Changed, Removed), which are appended to the changelog.

## Contributing

Pull requests, issues, and feature requests are welcome! Feel free to check out the [issues page](https://github.com/muad-dweeb/changelogbump/issues).

## License

This project is licensed under the MIT License.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "changelogbump",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "changelog, versioning, semantic, cli",
    "author": "Andrew Galloway",
    "author_email": "akq.galloway@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/84/0f/9ecd211b55a18bd8acf16c1b14dd69b3304f4c93ee68c7f67801a81bb636/changelogbump-0.3.0.tar.gz",
    "platform": null,
    "description": "# changelogbump\n\n[![Python](https://img.shields.io/badge/python3-555555?style=for-the-badge&logo=python&logoColor=ffdd54)](https://www.python.org)\n[![Poetry](https://img.shields.io/badge/Poetry-555555?style=for-the-badge&logo=Poetry)](https://python-poetry.org/)\n![PyPI - Version](https://img.shields.io/pypi/v/ChangelogBump?style=for-the-badge&logo=PyPi&logoColor=EEEEEE&color=blue)\n\n\nA command-line tool that updates a project's changelog and bumps its semantic version according to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) conventions.\n\n## Features\n\n- Initializes a new CHANGELOG.md file with a standard header.\n- Increments the project version (major, minor, or patch) and updates:\n  - The pyproject.toml version.\n  - The changelog, prompting for added, changed, or removed entries.\n- Helps maintain strict adherence to semantic versioning.\n\n## Requirements\n\n- pyproject.toml\n\n## Installation\n\n1. Ensure you have Python 3.11 or newer installed.\n2. Install via pip:\n   ```bash\n   pip install changelogbump\n   ```\n\n## Usage\n\nFrom your terminal, run:\n\n- Initialize a fresh changelog in the project root (if not present):\n  ```bash\n  changelogbump init\n  ```\n\n- Add and bump your version, specifying the part to increment:\n  ```bash\n  changelogbump add --major\n  changelogbump add --minor\n  changelogbump add --patch\n  ```\n\n- Provide a summary for the version:\n  ```bash\n  changelogbump add --patch --summary \"Small bug fixes\"\n  ```\n\n- Check the currently installed version of changelogbump:\n  ```bash\n  changelogbump version\n  ```\n\nYou will be prompted for items to add under different sections (Added, Changed, Removed), which are appended to the changelog.\n\n## Contributing\n\nPull requests, issues, and feature requests are welcome! Feel free to check out the [issues page](https://github.com/muad-dweeb/changelogbump/issues).\n\n## License\n\nThis project is licensed under the MIT License.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A CLI tool to manage project versioning and changelogs with Keep a Changelog compliance.",
    "version": "0.3.0",
    "project_urls": {
        "Homepage": "https://github.com/muad-dweeb/changelogbump"
    },
    "split_keywords": [
        "changelog",
        " versioning",
        " semantic",
        " cli"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2b69bab81efc8628ca1837bc87c3adb6ce78b50a902d20bbff3b55d3d5aeb769",
                "md5": "2a30836e7ae0940450553ed4c9bfa807",
                "sha256": "a1ba006a070425cf96ca111475276b2ecd9bd67c1d8ed60f229452ad73dcfc6b"
            },
            "downloads": -1,
            "filename": "changelogbump-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2a30836e7ae0940450553ed4c9bfa807",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 7695,
            "upload_time": "2025-08-09T03:56:55",
            "upload_time_iso_8601": "2025-08-09T03:56:55.354853Z",
            "url": "https://files.pythonhosted.org/packages/2b/69/bab81efc8628ca1837bc87c3adb6ce78b50a902d20bbff3b55d3d5aeb769/changelogbump-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "840f9ecd211b55a18bd8acf16c1b14dd69b3304f4c93ee68c7f67801a81bb636",
                "md5": "0fba1c573aabd2208eef6d0ef4193867",
                "sha256": "336488c9010a08ea21cec241409006a84b0e339ff3890e31c48429d853de2d4d"
            },
            "downloads": -1,
            "filename": "changelogbump-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "0fba1c573aabd2208eef6d0ef4193867",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 5410,
            "upload_time": "2025-08-09T03:56:56",
            "upload_time_iso_8601": "2025-08-09T03:56:56.714295Z",
            "url": "https://files.pythonhosted.org/packages/84/0f/9ecd211b55a18bd8acf16c1b14dd69b3304f4c93ee68c7f67801a81bb636/changelogbump-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-09 03:56:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "muad-dweeb",
    "github_project": "changelogbump",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "changelogbump"
}
        
Elapsed time: 0.83971s