vrzn 0.1.0__tar.gz

vrzn-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Scott Arne Johnson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vrzn-0.1.0/PKG-INFO

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: vrzn
+Version: 0.1.0
+Summary: Language-agnostic version management across project files
+Author-email: Scott Arne Johnson <scott.arne.johnson@gmail.com>
+License-Expression: MIT
+Keywords: version,versioning,pep440,semver,cli
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich-click>=1.8
+Requires-Dist: tomli>=2.0; python_version < "3.11"
+Provides-Extra: yaml
+Requires-Dist: pyyaml>=6.0; extra == "yaml"
+Provides-Extra: dev
+Requires-Dist: invoke; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: pyyaml>=6.0; extra == "dev"
+Dynamic: license-file
+
+# vrzn
+
+**Author:** Scott Arne Johnson ([scott.arne.johnson@gmail.com](mailto:scott.arne.johnson@gmail.com))
+
+Language-agnostic version management across project files.
+
+## Overview
+
+Projects often store version numbers in multiple files: `pyproject.toml`, `__init__.py`, `CMakeLists.txt`, `package.json`, and others. When these fall out of sync, builds break and releases ship incorrect metadata.
+
+vrzn solves this by letting you declare every file that contains a version number in a single configuration file. It can then read, set, and bump versions across all of them at once, with full [PEP 440](https://peps.python.org/pep-0440/) support.
+
+## Installation
+
+Requires Python 3.10 or later.
+
+```bash
+pip install vrzn
+```
+
+For YAML config file support:
+
+```bash
+pip install 'vrzn[yaml]'
+```
+
+## Quick Start
+
+Create a `vrzn.toml` in your project root:
+
+```toml
+[[locations]]
+file = "pyproject.toml"
+type = "pyproject-version"
+
+[[locations]]
+file = "src/mypackage/__init__.py"
+type = "python-dunder"
+```
+
+Check that all version locations are in sync:
+
+```
+$ vrzn get
+
+                       vrzn — version report
+╭───────────────────────────┬───────────────────┬─────────┬────────╮
+│ File                      │ Location          │ Version │ Status │
+├───────────────────────────┼───────────────────┼─────────┼────────┤
+│ pyproject.toml            │ pyproject-version │  1.0.0  │   ok   │
+├───────────────────────────┼───────────────────┼─────────┼────────┤
+│ src/mypackage/__init__.py │ python-dunder     │  1.0.0  │   ok   │
+╰───────────────────────────┴───────────────────┴─────────┴────────╯
+
+  Consensus version: 1.0.0
+  All version numbers are consistent.
+```
+
+Set a specific version everywhere:
+
+```
+$ vrzn -y set 1.2.0
+
+  Setting version to 1.2.0
+
+                                updated files
+╭───────────────────────────┬───────────────────┬─────────┬───────┬─────────╮
+│ File                      │ Location          │ Current │  New  │ Result  │
+├───────────────────────────┼───────────────────┼─────────┼───────┼─────────┤
+│ pyproject.toml            │ pyproject-version │  1.0.0  │ 1.2.0 │ updated │
+│ src/mypackage/__init__.py │ python-dunder     │  1.0.0  │ 1.2.0 │ updated │
+╰───────────────────────────┴───────────────────┴─────────┴───────┴─────────╯
+
+  All versions set to 1.2.0.
+```
+
+Bump the version:
+
+```
+$ vrzn -y bump patch
+
+  Version bump: 1.2.0 → 1.2.1
+
+                                updated files
+╭───────────────────────────┬───────────────────┬─────────┬───────┬─────────╮
+│ File                      │ Location          │ Current │  New  │ Result  │
+├───────────────────────────┼───────────────────┼─────────┼───────┼─────────┤
+│ pyproject.toml            │ pyproject-version │  1.2.0  │ 1.2.1 │ updated │
+│ src/mypackage/__init__.py │ python-dunder     │  1.2.0  │ 1.2.1 │ updated │
+╰───────────────────────────┴───────────────────┴─────────┴───────┴─────────╯
+
+  Version bumped to 1.2.1.
+```
+
+Preview changes without writing files:
+
+```
+$ vrzn --dry-run bump minor
+
+  Version bump: 1.2.1 → 1.3.0
+
+                                    dry run
+╭───────────────────────────┬───────────────────┬─────────┬───────┬──────────────╮
+│ File                      │ Location          │ Current │  New  │    Result     │
+├───────────────────────────┼───────────────────┼─────────┼───────┼──────────────┤
+│ pyproject.toml            │ pyproject-version │  1.2.1  │ 1.3.0 │ would update │
+│ src/mypackage/__init__.py │ python-dunder     │  1.2.1  │ 1.3.0 │ would update │
+╰───────────────────────────┴───────────────────┴─────────┴───────┴──────────────╯
+
+  Dry run — no files were modified.
+```
+
+Pre-release workflows:
+
+```bash
+vrzn -y bump patch --pre rc  # 1.0.0 -> 1.0.1rc1
+vrzn -y bump pre             # 1.0.1rc1 -> 1.0.1rc2
+vrzn -y bump release         # 1.0.1rc2 -> 1.0.1
+```
+
+## CLI Reference
+
+### Global Options
+
+Global options must be placed before the subcommand (e.g., `vrzn --dry-run bump patch`).
+
+| Option | Description |
+|--------|-------------|
+| `--dry-run` | Show what would change without writing files. |
+| `--yes`, `-y` | Skip confirmation prompts. |
+| `--quiet`, `-q` | Machine-readable output, no tables. |
+| `--config`, `-c PATH` | Path to config file (overrides discovery). |
+
+### Commands
+
+#### `vrzn get`
+
+Display the current version in all configured files. Prints a table showing each location, its version, and whether it matches the consensus.
+
+With `--quiet`, prints only the consensus version string.
+
+**Exit codes:** `0` if all versions agree, `1` if mismatches exist, `2` if no config found.
+
+#### `vrzn set VERSION`
+
+Set all version numbers to VERSION. Accepts any PEP 440 version string (e.g., `1.0.0`, `1.0.0rc1`, `1.0.0.post1`). Non-normalized forms are accepted and automatically normalized.
+
+Prompts for confirmation unless `--yes` or `--dry-run` is set.
+
+**Exit codes:** `1` for invalid version format, `2` if no config found.
+
+#### `vrzn bump PART [--pre LABEL]`
+
+Bump the version number. PART must be one of: `major`, `minor`, `patch`, `pre`, `release`.
+
+Use `--pre` with a label (`alpha`, `a`, `beta`, `b`, `rc`) to enter a pre-release state. Use `bump pre` to increment an existing pre-release. Use `bump release` to finalize a pre-release to its stable version.
+
+If versions are out of sync, vrzn warns and uses a consensus version (most common across locations). Prompts for confirmation unless `--yes` or `--dry-run` is set.
+
+**Exit codes:** `1` for errors (no readable version, invalid bump operation), `2` if no config found.
+
+## Configuration
+
+vrzn searches up the directory tree for config in this order:
+
+1. `vrzn.toml`
+2. `vrzn.yaml`
+3. `vrzn.json`
+4. `pyproject.toml` (under `[tool.vrzn]`)
+
+### Built-in Presets
+
+| Preset | Matches | `base_only` |
+|--------|---------|:-----------:|
+| `pyproject-version` | `version = "X.Y.Z"` in TOML | no |
+| `python-dunder` | `__version__ = "X.Y.Z"` | no |
+| `python-version-info` | `__version_info__ = (X, Y, Z)` | yes |
+| `cmake-project` | `project(NAME VERSION X.Y.Z)` | yes |
+| `c-define` | `#define PREFIX_VERSION_MAJOR N` | yes |
+| `cargo-toml` | `version = "X.Y.Z"` in Cargo.toml | no |
+| `package-json` | `"version": "X.Y.Z"` in JSON | no |
+| `maven-pom` | `<version>X.Y.Z</version>` | no |
+| `gradle-version` | `version = 'X.Y.Z'` in Gradle | no |
+
+Presets marked `base_only` write only the `MAJOR.MINOR.PATCH` portion, ignoring pre-release or post-release suffixes.
+
+The `c-define` preset requires a `prefix` parameter:
+
+```toml
+[[locations]]
+file = "include/mylib.h"
+type = "c-define"
+prefix = "MYLIB"
+```
+
+### Custom Locations
+
+For files that don't match a built-in preset, use `custom` with explicit regex patterns:
+
+```toml
+[[locations]]
+file = "docs/conf.py"
+type = "custom"
+label = "Sphinx config"
+pattern = '(release\s*=\s*")[^"]+"'
+replacement = '\g<1>{version}"'
+extract = 'release\s*=\s*"([^"]+)"'
+```
+
+Replacement format variables: `{version}`, `{major}`, `{minor}`, `{patch}`, `{info_tuple}`.
+
+## Development
+
+```bash
+pip install --config-settings editable_mode=compat -e ".[dev,yaml]"
+pytest
+```
+
+## License
+
+MIT License. Copyright (c) 2026 Scott Arne Johnson. See [LICENSE](LICENSE) for details.

vrzn-0.1.0/README.md

@@ -0,0 +1,221 @@
+# vrzn
+
+**Author:** Scott Arne Johnson ([scott.arne.johnson@gmail.com](mailto:scott.arne.johnson@gmail.com))
+
+Language-agnostic version management across project files.
+
+## Overview
+
+Projects often store version numbers in multiple files: `pyproject.toml`, `__init__.py`, `CMakeLists.txt`, `package.json`, and others. When these fall out of sync, builds break and releases ship incorrect metadata.
+
+vrzn solves this by letting you declare every file that contains a version number in a single configuration file. It can then read, set, and bump versions across all of them at once, with full [PEP 440](https://peps.python.org/pep-0440/) support.
+
+## Installation
+
+Requires Python 3.10 or later.
+
+```bash
+pip install vrzn
+```
+
+For YAML config file support:
+
+```bash
+pip install 'vrzn[yaml]'
+```
+
+## Quick Start
+
+Create a `vrzn.toml` in your project root:
+
+```toml
+[[locations]]
+file = "pyproject.toml"
+type = "pyproject-version"
+
+[[locations]]
+file = "src/mypackage/__init__.py"
+type = "python-dunder"
+```
+
+Check that all version locations are in sync:
+
+```
+$ vrzn get
+
+                       vrzn — version report
+╭───────────────────────────┬───────────────────┬─────────┬────────╮
+│ File                      │ Location          │ Version │ Status │
+├───────────────────────────┼───────────────────┼─────────┼────────┤
+│ pyproject.toml            │ pyproject-version │  1.0.0  │   ok   │
+├───────────────────────────┼───────────────────┼─────────┼────────┤
+│ src/mypackage/__init__.py │ python-dunder     │  1.0.0  │   ok   │
+╰───────────────────────────┴───────────────────┴─────────┴────────╯
+
+  Consensus version: 1.0.0
+  All version numbers are consistent.
+```
+
+Set a specific version everywhere:
+
+```
+$ vrzn -y set 1.2.0
+
+  Setting version to 1.2.0
+
+                                updated files
+╭───────────────────────────┬───────────────────┬─────────┬───────┬─────────╮
+│ File                      │ Location          │ Current │  New  │ Result  │
+├───────────────────────────┼───────────────────┼─────────┼───────┼─────────┤
+│ pyproject.toml            │ pyproject-version │  1.0.0  │ 1.2.0 │ updated │
+│ src/mypackage/__init__.py │ python-dunder     │  1.0.0  │ 1.2.0 │ updated │
+╰───────────────────────────┴───────────────────┴─────────┴───────┴─────────╯
+
+  All versions set to 1.2.0.
+```
+
+Bump the version:
+
+```
+$ vrzn -y bump patch
+
+  Version bump: 1.2.0 → 1.2.1
+
+                                updated files
+╭───────────────────────────┬───────────────────┬─────────┬───────┬─────────╮
+│ File                      │ Location          │ Current │  New  │ Result  │
+├───────────────────────────┼───────────────────┼─────────┼───────┼─────────┤
+│ pyproject.toml            │ pyproject-version │  1.2.0  │ 1.2.1 │ updated │
+│ src/mypackage/__init__.py │ python-dunder     │  1.2.0  │ 1.2.1 │ updated │
+╰───────────────────────────┴───────────────────┴─────────┴───────┴─────────╯
+
+  Version bumped to 1.2.1.
+```
+
+Preview changes without writing files:
+
+```
+$ vrzn --dry-run bump minor
+
+  Version bump: 1.2.1 → 1.3.0
+
+                                    dry run
+╭───────────────────────────┬───────────────────┬─────────┬───────┬──────────────╮
+│ File                      │ Location          │ Current │  New  │    Result     │
+├───────────────────────────┼───────────────────┼─────────┼───────┼──────────────┤
+│ pyproject.toml            │ pyproject-version │  1.2.1  │ 1.3.0 │ would update │
+│ src/mypackage/__init__.py │ python-dunder     │  1.2.1  │ 1.3.0 │ would update │
+╰───────────────────────────┴───────────────────┴─────────┴───────┴──────────────╯
+
+  Dry run — no files were modified.
+```
+
+Pre-release workflows:
+
+```bash
+vrzn -y bump patch --pre rc  # 1.0.0 -> 1.0.1rc1
+vrzn -y bump pre             # 1.0.1rc1 -> 1.0.1rc2
+vrzn -y bump release         # 1.0.1rc2 -> 1.0.1
+```
+
+## CLI Reference
+
+### Global Options
+
+Global options must be placed before the subcommand (e.g., `vrzn --dry-run bump patch`).
+
+| Option | Description |
+|--------|-------------|
+| `--dry-run` | Show what would change without writing files. |
+| `--yes`, `-y` | Skip confirmation prompts. |
+| `--quiet`, `-q` | Machine-readable output, no tables. |
+| `--config`, `-c PATH` | Path to config file (overrides discovery). |
+
+### Commands
+
+#### `vrzn get`
+
+Display the current version in all configured files. Prints a table showing each location, its version, and whether it matches the consensus.
+
+With `--quiet`, prints only the consensus version string.
+
+**Exit codes:** `0` if all versions agree, `1` if mismatches exist, `2` if no config found.
+
+#### `vrzn set VERSION`
+
+Set all version numbers to VERSION. Accepts any PEP 440 version string (e.g., `1.0.0`, `1.0.0rc1`, `1.0.0.post1`). Non-normalized forms are accepted and automatically normalized.
+
+Prompts for confirmation unless `--yes` or `--dry-run` is set.
+
+**Exit codes:** `1` for invalid version format, `2` if no config found.
+
+#### `vrzn bump PART [--pre LABEL]`
+
+Bump the version number. PART must be one of: `major`, `minor`, `patch`, `pre`, `release`.
+
+Use `--pre` with a label (`alpha`, `a`, `beta`, `b`, `rc`) to enter a pre-release state. Use `bump pre` to increment an existing pre-release. Use `bump release` to finalize a pre-release to its stable version.
+
+If versions are out of sync, vrzn warns and uses a consensus version (most common across locations). Prompts for confirmation unless `--yes` or `--dry-run` is set.
+
+**Exit codes:** `1` for errors (no readable version, invalid bump operation), `2` if no config found.
+
+## Configuration
+
+vrzn searches up the directory tree for config in this order:
+
+1. `vrzn.toml`
+2. `vrzn.yaml`
+3. `vrzn.json`
+4. `pyproject.toml` (under `[tool.vrzn]`)
+
+### Built-in Presets
+
+| Preset | Matches | `base_only` |
+|--------|---------|:-----------:|
+| `pyproject-version` | `version = "X.Y.Z"` in TOML | no |
+| `python-dunder` | `__version__ = "X.Y.Z"` | no |
+| `python-version-info` | `__version_info__ = (X, Y, Z)` | yes |
+| `cmake-project` | `project(NAME VERSION X.Y.Z)` | yes |
+| `c-define` | `#define PREFIX_VERSION_MAJOR N` | yes |
+| `cargo-toml` | `version = "X.Y.Z"` in Cargo.toml | no |
+| `package-json` | `"version": "X.Y.Z"` in JSON | no |
+| `maven-pom` | `<version>X.Y.Z</version>` | no |
+| `gradle-version` | `version = 'X.Y.Z'` in Gradle | no |
+
+Presets marked `base_only` write only the `MAJOR.MINOR.PATCH` portion, ignoring pre-release or post-release suffixes.
+
+The `c-define` preset requires a `prefix` parameter:
+
+```toml
+[[locations]]
+file = "include/mylib.h"
+type = "c-define"
+prefix = "MYLIB"
+```
+
+### Custom Locations
+
+For files that don't match a built-in preset, use `custom` with explicit regex patterns:
+
+```toml
+[[locations]]
+file = "docs/conf.py"
+type = "custom"
+label = "Sphinx config"
+pattern = '(release\s*=\s*")[^"]+"'
+replacement = '\g<1>{version}"'
+extract = 'release\s*=\s*"([^"]+)"'
+```
+
+Replacement format variables: `{version}`, `{major}`, `{minor}`, `{patch}`, `{info_tuple}`.
+
+## Development
+
+```bash
+pip install --config-settings editable_mode=compat -e ".[dev,yaml]"
+pytest
+```
+
+## License
+
+MIT License. Copyright (c) 2026 Scott Arne Johnson. See [LICENSE](LICENSE) for details.

vrzn-0.1.0/pyproject.toml

@@ -0,0 +1,120 @@
+# Packaging configuration file for vrzn
+# ----------------------------------------------------------------------------------------------------------------------
+#   Guide: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
+#   Spec:  https://packaging.python.org/en/latest/specifications/pyproject-toml/
+#
+#   Note: The pyproject.toml spec is still being adopted by many tools and IDEs. For this reason, please place your
+#         requirements in the requirements.txt file. This spec is written to dynamically use those dependencies.
+
+
+# Choosing a build backend:
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/#choosing-a-build-backend
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "vrzn"
+dynamic = ["version", "dependencies"]
+description = "Language-agnostic version management across project files"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+keywords = ["version", "versioning", "pep440", "semver", "cli"]
+authors = [
+    {name = "Scott Arne Johnson", email = "scott.arne.johnson@gmail.com" }
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "Programming Language :: Python :: 3 :: Only",
+]
+
+[project.optional-dependencies]
+yaml = ["pyyaml>=6.0"]
+dev = ["invoke", "build", "pytest>=7.0", "pytest-cov", "pre-commit>=3.0", "ruff>=0.1.0", "mypy>=1.0", "pyyaml>=6.0"]
+
+[project.scripts]
+vrzn = "vrzn.cli:main"
+
+# ----------------------------------------------------------------------------------------
+# These configurations are specific to the `setuptools` build backend
+# ----------------------------------------------------------------------------------------
+
+[tool.setuptools.packages.find]
+
+# Indicate the name of our package
+include = ["vrzn*"]
+
+# Exclude any test directory
+exclude = ["*test*"]
+
+
+[tool.setuptools.dynamic]
+
+# Get the version from a "single source of truth"
+version = {attr = "vrzn.__version__"}
+
+# Package dependencies (these will be installed by pip)
+# https://packaging.python.org/discussions/install-requires-vs-requirements/
+dependencies = {file = ["requirements.txt"]}
+
+
+# ----------------------------------------------------------------------------------------
+# Ruff configuration (linting and formatting)
+# https://docs.astral.sh/ruff/configuration/
+# ----------------------------------------------------------------------------------------
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle errors
+    "F",    # pyflakes
+    "W",    # pycodestyle warnings
+    "I",    # isort
+    "UP",   # pyupgrade
+    "B",    # flake8-bugbear
+    "SIM",  # flake8-simplify
+]
+ignore = [
+    "E501",   # Line too long (handled by formatter)
+    "B008",   # Function call in default argument
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["vrzn"]
+
+
+# ----------------------------------------------------------------------------------------
+# MyPy configuration (type checking)
+# https://mypy.readthedocs.io/en/stable/config_file.html
+# ----------------------------------------------------------------------------------------
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_ignores = true
+ignore_missing_imports = true
+exclude = ["tests/", "build/", "dist/"]
+
+
+# ----------------------------------------------------------------------------------------
+# Pytest configuration
+# https://docs.pytest.org/en/stable/reference/customize.html
+# ----------------------------------------------------------------------------------------
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = [
+    "integration: marks tests as integration tests (deselect with '-m not integration')",
+    "slow: marks tests as slow (deselect with '-m not slow')",
+]
+filterwarnings = [
+    "ignore::DeprecationWarning:importlib._bootstrap",
+]

vrzn-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+rich-click>=1.8
+tomli>=2.0; python_version < "3.11"

vrzn-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vrzn-0.1.0/setup.py

@@ -0,0 +1,7 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# This file is here for compatibility: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+# Please put all configuration into pyproject.toml
+# ----------------------------------------------------------------------------------------------------------------------
+from setuptools import setup
+
+setup()