Release v2.0.0

Author: sco1

.bumper.toml

@@ -1,5 +1,6 @@
 [tool.bumper]
-current_version = "1.0.0"
+current_version = "2.0.0"
+versioning_type = "semver"
 
 [[tool.bumper.files]]
 file = "./pyproject.toml"

.github/workflows/lint_test.yml

@@ -16,9 +16,9 @@ jobs:
     - uses: actions/checkout@v4
 
     - name: Install uv
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@v6
       with:
-        version: "0.6.x"
+        version: "0.7.x"
         enable-cache: true
         cache-dependency-glob: "uv.lock"
 
@@ -45,9 +45,9 @@ jobs:
     - uses: actions/checkout@v4
 
     - name: Install uv
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@v6
       with:
-        version: "0.6.x"
+        version: "0.7.x"
         enable-cache: true
         cache-dependency-glob: "uv.lock"
 

.github/workflows/pypi_release.yml

@@ -19,9 +19,9 @@ jobs:
     - uses: actions/checkout@v4
 
     - name: Install uv
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@v6
       with:
-        version: "0.6.x"
+        version: "0.7.x"
         enable-cache: true
         cache-dependency-glob: "uv.lock"
 

.pre-commit-config.yaml

@@ -35,6 +35,6 @@ repos:
       -  id: python-check-blanket-type-ignore
       -  id: python-use-type-annotations
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.4
+    rev: v0.11.8
     hooks:
       - id: ruff

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 Versions follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html) (`<major>`.`<minor>`.`<patch>`)
 
+## [v2.0.0]
+### Changed
+* #7 `versioning_type` is now a required configuration key for the `[tool.bumper]` table
+
+### Added
+* #7 Add support for CalVer, specified as `<YYYY>.<0M>.<MICRO>`
+
 ## [v1.0.0]
 Initial release

README.md

@@ -1,5 +1,5 @@
 # bumper
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sco1-bumper/1.0.0?logo=python&logoColor=FFD43B)](https://pypi.org/project/sco1-bumper/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sco1-bumper/2.0.0?logo=python&logoColor=FFD43B)](https://pypi.org/project/sco1-bumper/)
 [![PyPI](https://img.shields.io/pypi/v/sco1-bumper?logo=Python&logoColor=FFD43B)](https://pypi.org/project/sco1-bumper/)
 [![PyPI - License](https://img.shields.io/pypi/l/sco1-bumper?color=magenta)](https://github.com/sco1/bumper/blob/main/LICENSE)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sco1/bumper/main.svg)](https://results.pre-commit.ci/latest/github/sco1/bumper/main)
@@ -8,6 +8,12 @@ Automatically increment the project's version number.
 
 Heavily inspired by [`bump2version`](https://github.com/c4urself/bump2version) and [`bumpversion`](https://github.com/peritus/bumpversion). While [`bump-my-version`](https://github.com/callowayproject/bump-my-version) is an excellent modern fork this functionality, I'd like a pared down version of the offered feature set for my personal projects.
 
+## Supported Versioning Schemes
+* [Semantic Versioning (SemVer)](https://semver.org/#semantic-versioning-200)
+  * Assumes `<MAJOR>.<MINOR>.<PATCH>`
+* [Calendar Versioning (CalVer)](https://calver.org/)
+  * Assumes `<YYYY>.<0M>.<MICRO>`
+
 ## Installation
 Install from PyPi with your favorite `pip` invocation, e.g.:
 
@@ -21,10 +27,10 @@ import cog
 from subprocess import PIPE, run
 out = run(["bumper", "--help"], stdout=PIPE, encoding="ascii")
 cog.out(
-    f"```bash\n$ bumper --help\n{out.stdout.rstrip()}\n```"
+    f"```\n$ bumper --help\n{out.stdout.rstrip()}\n```"
 )
 ]]] -->
-```bash
+```
 $ bumper --help
 Usage: bumper [OPTIONS] COMMAND [ARGS]...
 
@@ -42,7 +48,7 @@ Commands:
 ### Required Fields
 #### `tool.bumper`
 * `current_version` - The current software version. This is automatically incremented when bumping.
-  * **NOTE:** Only SemVer is supported
+* `versioning_type` - Versioning type to be used, accepted values are `"semver"` and `"calver"`
 
 #### `tool.bumper.files`
 * `file` - Path to target file relative to the repository root
@@ -51,9 +57,22 @@ Commands:
 ### Example Configuration
 The basic configuration looks something like the following:
 
+#### SemVer
 ```toml
 [tool.bumper]
 current_version = "0.1.0"
+versioning_type = "semver"
+
+[[tool.bumper.files]]
+file = "./pyproject.toml"
+search = 'version = "{current_version}"'
+```
+
+#### CalVer
+```toml
+[tool.bumper]
+current_version = "2025.01.0"
+versioning_type = "calver"
 
 [[tool.bumper.files]]
 file = "./pyproject.toml"
@@ -65,6 +84,7 @@ Multiple replacements within the same file can also be specified:
 ```toml
 [tool.bumper]
 current_version = "0.1.0"
+versioning_type = "semver"
 
 [[tool.bumper.files]]
 file = "./pyproject.toml"
@@ -88,20 +108,29 @@ import cog
 from subprocess import PIPE, run
 out = run(["bumper", "bump", "--help"], stdout=PIPE, encoding="ascii")
 cog.out(
-    f"```bash\n$ bumper bump --help\n{out.stdout.rstrip()}\n```"
+    f"```\n$ bumper bump --help\n{out.stdout.rstrip()}\n```"
 )
 ]]] -->
-```bash
+```
 $ bumper bump --help
-Usage: bumper bump [OPTIONS] BUMP_BY:{major|minor|patch}
+Usage: bumper bump [OPTIONS] BUMP_BY:{major|minor|patch|date}
 
   Bump the requested version component.
 
+  Allowable `BUMP_BY` values differ based on the project's specified
+  versioning type: SemVer - (major, minor, patch), CalVer - (date)
+
+  When using CalVer, if the user's current UTC month is the same as the
+  current project version, then the Micro component is incremented. Otherwise,
+  the date components are bumped to the user's current UTC month and Micro
+  reset to `0`.
+
   If `dry_run` is `True`, the requested diff will be displayed in the terminal
   & no file modifications will take place.
 
 Arguments:
-  BUMP_BY:{major|minor|patch}  [required]
+  BUMP_BY:{major|minor|patch|date}
+                                  [required]
 
 Options:
   --dry-run / --no-dry-run  Preview the requested diff.  [default: no-dry-run]
@@ -112,17 +141,17 @@ Options:
 ### `bumper init`
 A small helper to initialize a starter `.bumper.toml` file that bumps the `version` field of your project's `pyproject.toml` file.
 
-**NOTE:** This starter file is initialized at version `0.1.0`, so be sure to update this value with your current version number before using bumper.
+**NOTE:** Be sure to update the sample version with your current version number before bumping with bumper.
 
 <!-- [[[cog
 import cog
 from subprocess import PIPE, run
 out = run(["bumper", "init", "--help"], stdout=PIPE, encoding="ascii")
 cog.out(
-    f"```bash\n$ bumper init --help\n{out.stdout.rstrip()}\n```"
+    f"```\n$ bumper init --help\n{out.stdout.rstrip()}\n```"
 )
 ]]] -->
-```bash
+```
 $ bumper init --help
 Usage: bumper init [OPTIONS]
 
@@ -133,6 +162,8 @@ Usage: bumper init [OPTIONS]
   configuration will be preserved.
 
 Options:
+  --versioning-type [semver|calver]
+                                  [default: semver]
   --ignore-existing / --no-ignore-existing
                                   [default: no-ignore-existing]
   --help                          Show this message and exit.

bumper/bump.py

@@ -1,4 +1,5 @@
 import copy
+import datetime as dt
 import difflib
 from collections import defaultdict
 from enum import StrEnum
@@ -10,19 +11,36 @@
 
 
 class BumpType(StrEnum):  # noqa: D101
+    # SemVer only
     MAJOR = "major"
     MINOR = "minor"
     PATCH = "patch"
 
+    # CalVer only
+    DATE = "date"
+
 
 def _build_new_version(current_version: version.Version, bump_type: BumpType) -> version.Version:
-    major, minor, patch = current_version.major, current_version.minor, current_version.micro
-    if bump_type is BumpType.MAJOR:
-        new_version = version.Version(f"{major+1}.0.0")
-    elif bump_type is BumpType.MINOR:
-        new_version = version.Version(f"{major}.{minor+1}.0")
-    elif bump_type is BumpType.PATCH:  # pragma: no branch
-        new_version = version.Version(f"{major}.{minor}.{patch+1}")
+    if bump_type == BumpType.DATE:
+        utc_date = dt.datetime.now(dt.timezone.utc).date()
+        version_year, version_month, version_micro = (
+            current_version.major,
+            current_version.minor,
+            current_version.micro,
+        )
+
+        if (version_year == utc_date.year) and (version_month == utc_date.month):
+            new_version = version.Version(f"{version_year}.{version_month:02}.{version_micro+1}")
+        else:
+            new_version = version.Version(f"{utc_date.year}.{utc_date.month:02}.0")
+    else:
+        major, minor, patch = current_version.major, current_version.minor, current_version.micro
+        if bump_type is BumpType.MAJOR:
+            new_version = version.Version(f"{major+1}.0.0")
+        elif bump_type is BumpType.MINOR:
+            new_version = version.Version(f"{major}.{minor+1}.0")
+        elif bump_type is BumpType.PATCH:  # pragma: no branch
+            new_version = version.Version(f"{major}.{minor}.{patch+1}")
 
     return new_version
 
@@ -42,10 +60,17 @@ def bump_ver(
     """
     Bump the current version according to the provided rules in `files`.
 
-    **NOTE:** Ensure that the bumper configuration file is included in the rules passed to `files`.
-
     If `dry_run` is `True`, files will not be modified and a per-file diff will be printed to the
     terminal instead.
+
+    If using CalVer (`bump_type` == `BumpType.DATE`), if the user's current UTC month is the same as
+    the current project version, then the Micro component is incremented. Otherwise, the date
+    components are bumped to the user's current UTC month and Micro reset to `0`.
+
+    NOTE: Ensure that the bumper configuration file is included in the rules passed to `files`.
+
+    NOTE: It is assumed that `bump_type` is appropriate for the project's configured versioning
+    type.
     """
     next_version = _build_new_version(current_version, bump_type)
     file_operations = _merge_bumpers(files)  # Merge so we handle each file all at once

bumper/cli.py

@@ -8,16 +8,14 @@
     BumperConfigError,
     BumperFile,
     ExistingConfigError,
+    VersioningType,
     parse_config,
     write_default_config,
 )
 
 bumper_cli = typer.Typer(add_completion=False)
 
 
-class ConfigNotFoundError(Exception): ...  # noqa: D101
-
-
 def _abort_with_message(message: str, end: str = "\n") -> t.Never:
     print(message, end=end)
     raise typer.Abort()
@@ -31,35 +29,53 @@ def bump_ver_cmd(
     """
     Bump the requested version component.
 
+    Allowable `BUMP_BY` values differ based on the project's specified versioning type: SemVer -
+    (major, minor, patch), CalVer - (date)
+
+    When using CalVer, if the user's current UTC month is the same as the current project version,
+    then the Micro component is incremented. Otherwise, the date components are bumped to the user's
+    current UTC month and Micro reset to `0`.
+
     If `dry_run` is `True`, the requested diff will be displayed in the terminal & no file
     modifications will take place.
     """
     for cfg_path in CONFIG_PRIORITY:
         if cfg_path.exists():
             break
     else:
-        raise ConfigNotFoundError("Configuration file could not be located.")
+        _abort_with_message("Configuration file could not be located.")
 
     try:
-        current_version, files = parse_config(cfg_path)
+        current_version, versioning_type, files = parse_config(cfg_path)
     except BumperConfigError as e:
         _abort_with_message(str(e))
 
+    # Check valid bump_by before we attempt to build a new version
+    if versioning_type == VersioningType.SEMVER:
+        if bump_by == BumpType.DATE:
+            _abort_with_message("SemVer projects must bump by major, minor, or patch.")
+    elif versioning_type == VersioningType.CALVER:
+        if bump_by != BumpType.DATE:
+            _abort_with_message("CalVer projects must bump by date.")
+
     # Add in the bump configuration so it gets updated as well
     files.append(BumperFile(file=cfg_path, search='current_version = "{current_version}"'))
     bump_ver(current_version=current_version, files=files, bump_type=bump_by, dry_run=dry_run)
 
 
 @bumper_cli.command()
-def init(ignore_existing: bool = typer.Option(False)) -> None:
+def init(
+    versioning_type: VersioningType = VersioningType.SEMVER,
+    ignore_existing: bool = typer.Option(False),
+) -> None:
     """
     Generate a default bumper configuration file.
 
     If the `--ignore_existing` flag is set, any existing `.bumper.toml` file will be overwritten;
     this action is not reversible. Otherwise, the existing configuration will be preserved.
     """
     try:
-        write_default_config(ignore_existing)
+        write_default_config(versioning_type=versioning_type, ignore_existing=ignore_existing)
     except ExistingConfigError as e:
         _abort_with_message(str(e))