bumpversion-slim 0.1.0__tar.gz

bumpversion_slim-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,26 @@
+# Set a conventional commit style topic
+
+```
+<type>[(optional scope)][!]: <description>
+```
+
+feat: what new feature was added
+feat!: what breaking change was made
+feat(scope): change to scope
+
+# Replace this description with additional information to be included in merge commit
+
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+
+```
+[optional body]
+
+[optional footer(s)]
+```
+
+```
+More details about the change.
+
+BREAKING CHANGE:
+Refs: #{issue}
+```

bumpversion_slim-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.9.x"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+
+    - name: Publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PUBLISH_TOKEN }}
+      run: |
+        uv build
+        uvx twine upload dist/*

bumpversion_slim-0.1.0/.github/workflows/publish_docs.yml

@@ -0,0 +1,26 @@
+name: publish_docs
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

bumpversion_slim-0.1.0/.github/workflows/style.yml

@@ -0,0 +1,35 @@
+name: Style
+
+on:
+  push:
+    branches:
+      # Push will only build on branches that match this name
+      # Pull requests will override this, so pushes to pull requests will still build
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check-style:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10.x"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+
+    - name: Install dependencies
+      run: |
+        uv sync --all-extras
+
+    - name: Lint with astral
+      run: |
+        uv run prek run --all-files

bumpversion_slim-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,70 @@
+name: Test
+
+on:
+  push:
+    branches:
+      # Push will only build on branches that match this name
+      # Pull requests will override this, so pushes to pull requests will still build
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+
+  test-coverage:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10.x"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+
+    - name: Install dependencies
+      run: uv sync --all-extras
+
+    - name: Generate coverage report
+      run: |
+        uv run pytest --cov-report=xml --cov-config=pyproject.toml -vvv
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: NRWLDev/bumpversion-slim
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        yml: ./codecov.yml
+        fail_ci_if_error: false
+
+  test-python-versions:
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        version: ["3.10.x", "3.11.x", "3.12.x", "3.13.x", "3.14.x"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+
+    - name: Install dependencies
+      run: uv sync --all-extras
+
+    - name: Test with pytest
+      run: |
+        uv run pytest

bumpversion_slim-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

bumpversion_slim-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: tests/test_cli.py
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: check-toml
+      - id: fix-byte-order-marker
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1
+    hooks:
+      - id: typos
+        args: [--force-exclude]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.5
+    hooks:
+      - id: ruff-format
+        args: [--preview, -s]
+      - id: ruff
+        args: [--fix]
+
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty check
+        entry: ty check .
+        language: system
+        pass_filenames: false
+        always_run: true
+
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.6
+    hooks:
+      - id: remove-crlf
+        exclude: docs
+      - id: remove-tabs
+        exclude: docs

bumpversion_slim-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

bumpversion_slim-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.0 (released 2026-03-07)
+
+### Documentation
+
+- Update overview page.[[c3680e0](https://github.com/NRWLDev/bumpversion-slim/commit/c3680e0e072ffdf254fe8d326199d452460ea3ec)]
+- Add documentation around usage and configuration.[[f7000fb](https://github.com/NRWLDev/bumpversion-slim/commit/f7000fb134461e1fd86da754a1e9144bb636892a)]
+
+### Miscellaneous
+
+- Add invoke tasks for installation, test and release management.[[955308e](https://github.com/NRWLDev/bumpversion-slim/commit/955308e9ab8699a1fb5c8f3f8e15605be018c31a)]
+- Update tests to include config parameter in Context object.[[aba27d9](https://github.com/NRWLDev/bumpversion-slim/commit/aba27d918677cc477051c66134f42e263244faf3)]
+- Add github action pipelines[[eff830a](https://github.com/NRWLDev/bumpversion-slim/commit/eff830a6130de32ebb870db91f69af9c504304b5)]
+- Add initial test suite.[[5a32e46](https://github.com/NRWLDev/bumpversion-slim/commit/5a32e46df90de8c37b0684ac9f1063ec6e8a538a)]
+- Add git-cliff, prek and bumpversion configuration.[[d93f8b4](https://github.com/NRWLDev/bumpversion-slim/commit/d93f8b4b2a8d0a79daacfff851b863a259a6b4e7)]
+- Extracted version bumping pieces from changelog-gen library.[[220c89f](https://github.com/NRWLDev/bumpversion-slim/commit/220c89f4ddcdb11e33eee85024eccbaaa5399b12)]
+
+<!-- generated by git-cliff -->

bumpversion_slim-0.1.0/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: bumpversion-slim
+Version: 0.1.0
+Summary: A lightweight tool to bump package versions
+Author-email: Daniel Edgecombe <daniel@nrwl.co>
+License-Expression: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Version Control
+Classifier: Topic :: System :: Software Distribution
+Requires-Python: >=3.10
+Requires-Dist: gitpython>=3.1.46
+Requires-Dist: rtoml>=0.13.0
+Provides-Extra: dev
+Requires-Dist: git-cliff>=2.12.0; extra == 'dev'
+Requires-Dist: prek>=0.3.4; extra == 'dev'
+Requires-Dist: ruff>=0.14.10; extra == 'dev'
+Requires-Dist: ty>=0.0.17; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: freezegun>=1.2.1; extra == 'test'
+Requires-Dist: path<17,>=16; extra == 'test'
+Requires-Dist: pytest-cov>=7.0.0; extra == 'test'
+Requires-Dist: pytest-git<1.8,>=1.7.0; extra == 'test'
+Requires-Dist: pytest-httpx>=0.36.0; extra == 'test'
+Requires-Dist: pytest-random-order>=1.2.0; extra == 'test'
+Requires-Dist: pytest>=9.0.0; extra == 'test'

bumpversion_slim-0.1.0/docs/configuration.md

@@ -0,0 +1,170 @@
+# Configuration
+
+General configuration is grouped in the `[tool.bumpversion]` section of pyproject.toml.
+
+## Simple configuration
+
+```toml
+[tool.bumpversion]
+current_version = "1.2.3"
+allowed_branches = [
+    "main",
+]
+
+[[tool.bumpversion.files]]
+filename = "README.md"
+```
+
+### `commit`
+  _**[optional]**_<br />
+  **default**: True
+
+  Commit version replacement changes to the configured files.
+
+  Also available as `--commit/--no-commit` (e.g. `bumpversion 1.2.3 --commit`)
+
+### `tag`
+  _**[optional]**_<br />
+  **default**: True
+
+  Tag the committed changes with the new version.
+
+  Also available as `--tag/--no-tag` (e.g. `bumpversion 1.2.3 --tag`)
+
+### `allow_dirty`
+  _**[optional]**_<br />
+  **default**: False
+
+  Don't abort if the current branch contains uncommitted changes
+
+  Also available as `--allow-dirty` (e.g. `bumpversion 1.2.3 --allow-dirty`)
+
+### `allow_missing`
+  _**[optional]**_<br />
+  **default**: False
+
+  Don't abort if the local and remote branches are out of sync.
+
+  Also available as `--allow-missing` (e.g. `bumpversion 1.2.3 --allow-missing`)
+
+### `version_string`
+  _**[optional]**_<br />
+  **default**: `v{new_version}`
+
+  Format for the version tag, this will be passed into commit messages.
+
+  Example:
+
+```toml
+[tool.bumpversion]
+version_string = "{new_version}"
+```
+
+### `commit_extra`
+  _**[optional]**_<br />
+  **default**: None
+
+  Additional file(s) to commit even if `bumpversion` has not modified them
+  itself. Useful if another tool has modified a file in a previous pipeline
+  step.
+
+  Example:
+
+```toml
+[tool.bumpversion]
+commit_extra = [
+    "CHANGELOG.md",
+]
+```
+
+### `allowed_branches`
+  _**[optional]**_<br />
+  **default**: None
+
+  Prevent version being bumped if the current branch is not in the
+  supplied list. By default all branches are allowed.
+
+  Example:
+
+```toml
+[tool.bumpversion]
+allowed_branches = [
+  "main",
+  "develop",
+]
+```
+
+### `hooks`
+  _**[optional]**_<br />
+  **default**: None
+
+  Run additional hooks when generating a release, this allows regenerating
+  automated documentation during release process, for example.
+
+  Example:
+
+```toml
+[tool.bumpversion]
+hooks = [
+  "path.to.module:hook_function",
+]
+```
+
+### `custom`
+  _**[optional]**_<br />
+  **default**: None
+
+  Arbitrary configuration that can be used in hooks.
+
+  Example:
+
+```toml
+[tool.bumpversion.custom]
+key = "value"
+a_list = ["key", "key2"]
+```
+
+## Versioning
+
+Versioning configuration is very similar to
+[bump-my-version](https://github.com/callowayproject/bump-my-version?tab=readme-ov-file#semantic-versioning-example),
+but with a few simplifications.
+
+The default configuration will support the typical semver use case of `X.Y.Z`
+version strings.
+
+### `current_version`
+  _**[optional]**_<br />
+  **default**: None
+
+  The minimum required configuration to manage versions is the current version,
+  which can be moved directly from `[tool.bumpversion]`
+
+```toml
+[tool.bumpversion]
+current_version = "1.2.3"
+```
+
+### `files`
+  _**[optional]**_<br />
+  **default**: None
+
+  If multiple files have the current version string in them, they can be
+  configured for replacement.
+
+  Where the version string can safely be replaced with the default pattern
+  `{version}`, use:
+
+```
+[[tool.bumpversion.files]]
+filename = "README.md"
+```
+
+  For files that might contain other version strings that could match and
+  shouldn't be updated, a search/replace pattern can be configured.
+
+```
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+pattern = 'version = "{version}"'
+```

bumpversion_slim-0.1.0/docs/favicon.svg

@@ -0,0 +1,28 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="1200.000000pt" height="867.000000pt" viewBox="0 0 1200.000000 867.000000"
+ preserveAspectRatio="xMidYMid meet">
+
+<g transform="translate(0.000000,867.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M5217 8013 c-3 -5 -507 -1396 -1120 -3093 -614 -1697 -1210 -3347
+-1326 -3668 -116 -321 -211 -587 -211 -593 0 -5 1297 -9 3440 -9 2746 0 3440
+3 3439 13 0 6 -597 1664 -1327 3682 l-1328 3670 -781 3 c-430 1 -784 -1 -786
+-5z m2620 -3788 c114 -34 185 -127 185 -244 0 -54 -15 -98 -150 -435 l-149
+-375 57 -35 c69 -43 152 -130 185 -195 59 -118 60 -127 60 -616 0 -438 -1
+-451 -21 -495 -12 -25 -36 -60 -55 -78 -68 -69 -50 -66 -519 -72 l-425 -5 2
+-37 c5 -77 69 -159 153 -197 42 -19 65 -21 328 -21 320 0 297 7 265 -85 -10
+-31 -34 -67 -63 -96 -84 -84 -11 -79 -1211 -79 -663 0 -1095 4 -1160 10 -357
+37 -675 185 -927 433 -224 220 -350 445 -430 767 l-26 105 -3 623 -4 622 38 0
+c218 -2 428 -197 465 -433 12 -77 12 -77 43 -77 98 0 241 -66 325 -150 84 -85
+150 -227 150 -327 l0 -33 -256 0 -257 0 7 -61 c29 -255 250 -449 511 -449 163
+0 316 72 499 233 37 32 156 157 266 277 309 338 436 438 621 490 63 17 104 20
+279 20 l205 0 384 480 c396 497 418 520 504 540 49 12 69 11 124 -5z"/>
+<path d="M7456 3590 c-163 -203 -296 -372 -296 -375 0 -3 68 -4 152 -3 l152 3
+148 369 c81 203 146 371 144 373 -2 2 -137 -163 -300 -367z"/>
+<path d="M6824 2176 c-49 -22 -74 -61 -74 -118 0 -43 5 -55 33 -83 43 -43 79
+-52 131 -34 107 37 115 184 13 232 -42 20 -62 21 -103 3z"/>
+</g>
+</svg>

bumpversion_slim-0.1.0/docs/hooks.md

@@ -0,0 +1,92 @@
+# Hooks
+
+During the version bump process, some internal hooks to bumping version files
+are run, during this step custom hooks can be run as well if there are other
+steps you need to run as part of a release. A good example of this could be
+regenerating automated docstring documentation.
+
+The hook function format is relatively simple, it takes in the current context,
+as well as the new version string, and must return a list of the
+files, if any, that were modified. The new version is provided to allow
+using the values as parameters if required. The context object provides
+messaging ability as well as access to the current config object.
+
+```python
+from bumpversion_slim.context import Context
+
+def my_hook(context: Context, new: str) -> list[str]:
+    # Perform desired operation
+
+    context.error("Display something to the user.")
+    return ["/path/to/file1", "/path/to/file2"]
+```
+See
+[hooks](https://nrwldev.github.io/bumpversion-slim/configuration/#hooks)
+for details on configuring custom hooks.
+
+
+## Context
+
+The context object provides access to the current configuration
+`context.config` as well as to convenience methods for outputting information,
+based on current verbosity settings.
+
+* error: Always display
+* warning: Display for -v verbosity or higher
+* info: Display for -vv verbosity or higher
+* debug: Display for -vvv verbosity or higher
+
+The above methods accept a % format string, and `*args`. i.e.
+`context.error("Hello, %s", "world")`.  To access the current version, extract
+it from `context.config.current_version`.
+
+### Configuration
+
+Custom configuration can be accessed  with `context.config.custom`. This is a
+dictionary containing all values defined in `[tool.bumpversion.custom]`.  See
+[custom](https://nrwldev.github.io/bumpversion/configuration/#custom) for
+details on providing custom configuration.
+
+## Example
+
+Here is a full example used in another project to generate `.md` files from
+docstrings (using pdoc3 library), this will output a `module_name/`  directory
+in the local `docs/` directory containing all modules and submodule `.md`
+files.
+
+
+```python
+import re
+from pathlib import Path
+
+import pdoc
+from bumpversion_slim.context import Context
+
+
+def hook(context: Context, _new: str) -> list[str]:
+    output_dir = Path("./docs")
+    modules = ["module_name"]
+    pcontext = pdoc.Context()
+
+    modules = [pdoc.Module(mod, context=pcontext) for mod in modules]
+    pdoc.link_inheritance(pcontext)
+
+    def recursive_mds(mod: pdoc.Module) -> pdoc.Module:
+        yield mod
+        for submod in mod.submodules():
+            yield from recursive_mds(submod)
+
+    paths = []
+
+    for mod in modules:
+        for module in recursive_mds(mod):
+            path = re.sub(r"\.html$", ".md", module.url())
+            out = output_dir / path
+            out.parent.mkdir(exist_ok=True, parents=True)
+            with out.open("w") as f:
+                f.write(module.text())
+            context.info("Generated documentation for %s module", module.name)
+            paths.append(str(out))
+
+    return paths
+```

bumpversion_slim-0.1.0/docs/index.md

@@ -0,0 +1,37 @@
+# Overview
+
+This tool is intended as a very light version of
+[bump-my-version](https://github.com/callowayproject/bump-my-version). It does
+not provide semantic version generation, instead relying on the version
+specifically being supplied. This is due to this projects intention of
+augmenting [git-cliff](), which provides changelog generation from conventional
+commits as well as semantic versioning, but does not provide file update
+functionality or commit/tag support.
+
+A basic pyproject.toml configuration can be as simple as:
+
+```toml
+[tool.bumpversion]
+current_version = "0.0.0"
+commit_extra = ["CHANGELOG.md"]
+```
+
+## Bumping the version
+
+Run `bumpversion VERSION_STRING` to update configured files with the new
+version string, commit and tag the release.
+
+If using in conjunction with `git-cliff` you can output the latest version
+string from the cli, and provide it to `bumpversion-slim`.
+
+```console
+> git-cliff --config pyproject.toml --bump -o CHANGELOG.md
+> VERSION=$(git-cliff --bumped-version)
+> bumpversion $VERSION
+```
+
+## Installation
+
+```bash
+pip install bumpversion-slim
+```

bumpversion_slim-0.1.0/docs/usage.md

@@ -0,0 +1,53 @@
+# Usage
+
+## Getting started
+
+This tool is intended as a very light version of
+[bump-my-version](https://github.com/callowayproject/bump-my-version). It does
+not provide semantic version generation, instead relying on the version
+specifically being supplied. This is due to this projects intention of
+augmenting [git-cliff](), which provides changelog generation from conventional
+commits as well as semantic versioning, but does not provide file update
+functionality or commit/tag support.
+
+A basic pyproject.toml configuration can be as simple as:
+
+```toml
+[tool.bumpversion]
+current_version = "0.0.0"
+commit_extra = ["CHANGELOG.md"]
+```
+
+## Bumping the version
+
+Run `bumpversion VERSION_STRING` to update configured files with the new
+version string, commit and tag the release.
+
+If using in conjunction with `git-cliff` you can output the latest version
+string from the cli, and provide it to `bumpversion-slim`.
+
+```console
+> git-cliff --config pyproject.toml --bump -o CHANGELOG.md
+> VERSION=$(git-cliff --bumped-version)
+> bumpversion $VERSION
+```
+
+### CLI options and toggles
+
+These options allow customising on a per run basis.
+
+* `--dry-run` extract changes and preview the proposed changelog and version
+  without committing or tagging any changes.
+* `-v[vv]` increase the output verbosity, handy if an error occurs or behaviour
+  does not appear to match expectations.
+
+The following toggles allow overriding configuration per run.
+
+* `--allow-dirty/--no-allow-dirty` toggle configuration for allowing/rejecting git dirty status.
+* `--allow-missing/--no-allow-missing` toggle configuration for allowing/rejecting missing commits in local/remote.
+* `--reject-empty/--no-reject-empty` toggle configuration for updating configured files.
+* `--commit/--no-commit` toggle configuration for committing changes.
+* `--tag/--no-tag` toggle configuration for tagging release changes.
+
+See [Configuration](/bumpversion/configuration) for additional configuration and cli flags that are available.
+and how to customize them.