| Name | bumpwright JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Static public-API diff + heuristics to suggest semantic version bumps. |
| upload_time | 2025-08-23 06:32:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License
Copyright (c) 2024 Lewis Morris
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.
|
| keywords |
semantic-versioning
semver
api
diff
release
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# bumpwright
Bumpwright is an automated semantic versioning tool. It analyzes code changes instead of relying on commit messages to suggest the right next version.
It compares your latest code against the last release with a single command. The tool tells you whether to bump the version by a patch, minor, or major, making accurate releases effortless for maintainers of libraries and services with stable interfaces.
**Docs:** https://lewis-morris.github.io/bumpwright/
**Guides:** https://lewis-morris.github.io/bumpwright/guides/
## Overview
### What & Why
Traditional release tools rely on commit messages, which can be inconsistent. Bumpwright inspects your project’s public API directly to decide the next version. This catches breaking changes even if commit messages miss them and can update version strings and generate changelog entries automatically, streamlining releases.
### How It Works
Bumpwright compares two Git references—usually the last release tag and the current commit—and detects changes in the public interface. Removed functions or changed signatures trigger a major bump; new features result in a minor bump; and bug fixes or small tweaks lead to a patch bump. Static analysis and optional analysers (for CLI commands, web routes, migrations, and more) drive these decisions. You can apply the suggestion, update files, and render changelog notes.
### Key Benefits
- **Simplicity** – run a single command to see how your API changed.
- **Accuracy** – catches breaking changes that commit messages may miss.
- **Flexibility** – configurable analysers and settings to fit your workflow.
- **Automation** – update version files and generate changelog entries.
### Trade-offs / Constraints
- **Baseline required** – needs a baseline reference (e.g., prior release tag); run `bumpwright init` to mark it.
- **Static analysis limits** – cannot account for runtime-specific changes or internal logic.
- **Python 3.11+** – focuses on Python projects and requires Python 3.11 or newer.
Get started with the [Quickstart guide](https://lewis-morris.github.io/bumpwright/quickstart.html).
---
## Install
```bash
pip install bumpwright # Python 3.11+
```
Bumpwright now uses Python's built-in `tomllib`, removing the need for the
external `tomli` dependency.
Full details: [Installation](https://lewis-morris.github.io/bumpwright/quickstart.html#installation)
---
## TL;DR (90 seconds)
```bash
# 1) Create a baseline release commit once
bumpwright init
# 2) Ask Bumpwright what the next version should be
bumpwright decide
# 3) Apply it, update files, commit and tag
bumpwright bump --commit --tag
```
What the decision means and examples: [Quickstart](https://lewis-morris.github.io/bumpwright/quickstart.html) • Command flags: [Usage → bump](https://lewis-morris.github.io/bumpwright/usage/bump.html)
| Command | Purpose |
|---------|---------|
| [`bumpwright init`](https://lewis-morris.github.io/bumpwright/usage/init.html) | Create a baseline release commit. |
| [`bumpwright bump`](https://lewis-morris.github.io/bumpwright/usage/bump.html) | Determine and apply the next version. |
| [`bumpwright history`](https://lewis-morris.github.io/bumpwright/usage/history.html) | View past releases in text, Markdown, or JSON and roll back a tag. |
---
## Configuration (minimal)
Bumpwright reads `bumpwright.toml` (you can change with `--config`). Defaults are sensible; start small and opt-in extras as needed.
```toml
# bumpwright.toml
[project]
public_roots = ["."]
# modifying modules here triggers at least a patch bump
private_prefixes = ["_"] # names starting with "_" are ignored as private
[analysers]
cli = true # set true to enable
grpc = false
web_routes = false
migrations = false
openapi = false
graphql = false
[changelog]
# path = "CHANGELOG.md" # optional default target for --changelog
repo_url = "https://github.com/me/project" # link commits and compares
[version]
scheme = "semver" # "semver" | "calver"
# paths / ignore have robust defaults
```
All options and defaults: [Configuration](https://lewis-morris.github.io/bumpwright/configuration.html) • Versioning schemes: [Versioning](https://lewis-morris.github.io/bumpwright/versioning.html)
---
## Output & Changelog
- Choose output with `--format text|md|json` for human/CI consumption.
- Generate release notes with a Jinja2 template via `--changelog` (and `--repo-url` or `[changelog].repo_url` for compare/commit links).
Template context includes: `version`, `date`, `release_datetime_iso`, `commits[sha,subject,link]`, `previous_tag`, `compare_url`, `contributors[name,link]`, `breaking_changes`, `repo_url`.
Learn more & ready-to-copy templates:
- [Changelog → Template variables](https://lewis-morris.github.io/bumpwright/changelog/template.html)
- [Changelog → Examples](https://lewis-morris.github.io/bumpwright/changelog/examples.html)
---
## Analysers (opt-in)
Enable what you need in `[analysers]` or per-run with `--enable-analyser/--disable-analyser`.
- **Python API (default)** – respects `__all__`; otherwise public = names not starting with `_`.
- **CLI** – detects changes to argparse/Click commands.
- **gRPC** – service and method diffs.
- **Web routes** – Flask/FastAPI route changes.
- **Migrations** – Alembic schema impacts.
- **OpenAPI** – spec diffs.
- **GraphQL** – schema diffs.
Overview & per-analyser docs: [Analysers](https://lewis-morris.github.io/bumpwright/analysers/)
---
## GitHub Actions (CI)
Common workflows are prebuilt:
- **Auto-bump on push** (commit + tag + append changelog)
- **PR check** (report decision only)
- **Manual release** (on dispatch)
Copy/paste from: [CI/CD (GitHub Actions)](https://lewis-morris.github.io/bumpwright/recipes/github-actions.html)
---
## Contributing & Roadmap
Issues and PRs welcome. See [Contributing](https://lewis-morris.github.io/bumpwright/contributing.html) and planned work in the [Roadmap](https://lewis-morris.github.io/bumpwright/roadmap.html).
**License:** [MIT](./LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "bumpwright",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "semantic-versioning, semver, api, diff, release",
"author": null,
"author_email": "Lewis Morris <lewis@arched.dev>",
"download_url": "https://files.pythonhosted.org/packages/02/67/7e95c229a1bd562b20d84f6bcc488a4fc761491b49273638eab6d3fc1fe9/bumpwright-0.2.0.tar.gz",
"platform": null,
"description": "# bumpwright\n\n\n\n\n\n\nBumpwright is an automated semantic versioning tool. It analyzes code changes instead of relying on commit messages to suggest the right next version.\n\nIt compares your latest code against the last release with a single command. The tool tells you whether to bump the version by a patch, minor, or major, making accurate releases effortless for maintainers of libraries and services with stable interfaces.\n\n**Docs:** https://lewis-morris.github.io/bumpwright/\n**Guides:** https://lewis-morris.github.io/bumpwright/guides/\n\n## Overview\n\n### What & Why\n\nTraditional release tools rely on commit messages, which can be inconsistent. Bumpwright inspects your project\u2019s public API directly to decide the next version. This catches breaking changes even if commit messages miss them and can update version strings and generate changelog entries automatically, streamlining releases.\n\n### How It Works\n\nBumpwright compares two Git references\u2014usually the last release tag and the current commit\u2014and detects changes in the public interface. Removed functions or changed signatures trigger a major bump; new features result in a minor bump; and bug fixes or small tweaks lead to a patch bump. Static analysis and optional analysers (for CLI commands, web routes, migrations, and more) drive these decisions. You can apply the suggestion, update files, and render changelog notes.\n\n### Key Benefits\n\n- **Simplicity** \u2013 run a single command to see how your API changed.\n- **Accuracy** \u2013 catches breaking changes that commit messages may miss.\n- **Flexibility** \u2013 configurable analysers and settings to fit your workflow.\n- **Automation** \u2013 update version files and generate changelog entries.\n\n### Trade-offs / Constraints\n\n- **Baseline required** \u2013 needs a baseline reference (e.g., prior release tag); run `bumpwright init` to mark it.\n- **Static analysis limits** \u2013 cannot account for runtime-specific changes or internal logic.\n- **Python 3.11+** \u2013 focuses on Python projects and requires Python 3.11 or newer.\n\nGet started with the [Quickstart guide](https://lewis-morris.github.io/bumpwright/quickstart.html).\n\n---\n\n## Install\n\n```bash\npip install bumpwright # Python 3.11+\n```\n\nBumpwright now uses Python's built-in `tomllib`, removing the need for the\nexternal `tomli` dependency.\n\nFull details: [Installation](https://lewis-morris.github.io/bumpwright/quickstart.html#installation)\n\n---\n\n## TL;DR (90 seconds)\n\n```bash\n# 1) Create a baseline release commit once\nbumpwright init\n\n# 2) Ask Bumpwright what the next version should be\nbumpwright decide\n\n# 3) Apply it, update files, commit and tag\nbumpwright bump --commit --tag\n```\n\nWhat the decision means and examples: [Quickstart](https://lewis-morris.github.io/bumpwright/quickstart.html) \u2022 Command flags: [Usage \u2192 bump](https://lewis-morris.github.io/bumpwright/usage/bump.html)\n\n| Command | Purpose |\n|---------|---------|\n| [`bumpwright init`](https://lewis-morris.github.io/bumpwright/usage/init.html) | Create a baseline release commit. |\n| [`bumpwright bump`](https://lewis-morris.github.io/bumpwright/usage/bump.html) | Determine and apply the next version. |\n| [`bumpwright history`](https://lewis-morris.github.io/bumpwright/usage/history.html) | View past releases in text, Markdown, or JSON and roll back a tag. |\n\n---\n\n## Configuration (minimal)\n\nBumpwright reads `bumpwright.toml` (you can change with `--config`). Defaults are sensible; start small and opt-in extras as needed.\n\n```toml\n# bumpwright.toml\n[project]\npublic_roots = [\".\"]\n# modifying modules here triggers at least a patch bump\nprivate_prefixes = [\"_\"] # names starting with \"_\" are ignored as private\n\n[analysers]\ncli = true # set true to enable\ngrpc = false\nweb_routes = false\nmigrations = false\nopenapi = false\ngraphql = false\n\n[changelog]\n# path = \"CHANGELOG.md\" # optional default target for --changelog\nrepo_url = \"https://github.com/me/project\" # link commits and compares\n\n[version]\nscheme = \"semver\" # \"semver\" | \"calver\"\n# paths / ignore have robust defaults\n```\n\nAll options and defaults: [Configuration](https://lewis-morris.github.io/bumpwright/configuration.html) \u2022 Versioning schemes: [Versioning](https://lewis-morris.github.io/bumpwright/versioning.html)\n\n---\n\n## Output & Changelog\n\n- Choose output with `--format text|md|json` for human/CI consumption.\n- Generate release notes with a Jinja2 template via `--changelog` (and `--repo-url` or `[changelog].repo_url` for compare/commit links).\n\nTemplate context includes: `version`, `date`, `release_datetime_iso`, `commits[sha,subject,link]`, `previous_tag`, `compare_url`, `contributors[name,link]`, `breaking_changes`, `repo_url`.\n\nLearn more & ready-to-copy templates: \n- [Changelog \u2192 Template variables](https://lewis-morris.github.io/bumpwright/changelog/template.html) \n- [Changelog \u2192 Examples](https://lewis-morris.github.io/bumpwright/changelog/examples.html)\n\n---\n\n## Analysers (opt-in)\n\nEnable what you need in `[analysers]` or per-run with `--enable-analyser/--disable-analyser`.\n\n- **Python API (default)** \u2013 respects `__all__`; otherwise public = names not starting with `_`. \n- **CLI** \u2013 detects changes to argparse/Click commands. \n- **gRPC** \u2013 service and method diffs.\n- **Web routes** \u2013 Flask/FastAPI route changes. \n- **Migrations** \u2013 Alembic schema impacts. \n- **OpenAPI** \u2013 spec diffs. \n- **GraphQL** \u2013 schema diffs.\n\nOverview & per-analyser docs: [Analysers](https://lewis-morris.github.io/bumpwright/analysers/)\n\n---\n\n## GitHub Actions (CI)\n\nCommon workflows are prebuilt:\n\n- **Auto-bump on push** (commit + tag + append changelog) \n- **PR check** (report decision only) \n- **Manual release** (on dispatch)\n\nCopy/paste from: [CI/CD (GitHub Actions)](https://lewis-morris.github.io/bumpwright/recipes/github-actions.html)\n\n---\n\n## Contributing & Roadmap\n\nIssues and PRs welcome. See [Contributing](https://lewis-morris.github.io/bumpwright/contributing.html) and planned work in the [Roadmap](https://lewis-morris.github.io/bumpwright/roadmap.html).\n\n**License:** [MIT](./LICENSE)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Lewis Morris\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Static public-API diff + heuristics to suggest semantic version bumps.",
"version": "0.2.0",
"project_urls": {
"bug_tracker": "https://github.com/arched-dev/bumpwright/issues",
"documentation": "https://lewis-morris.github.io/bumpwright/",
"homepage": "https://github.com/arched-dev/bumpwright",
"repository": "https://github.com/arched-dev/bumpwright"
},
"split_keywords": [
"semantic-versioning",
" semver",
" api",
" diff",
" release"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4dc9823afc9c1c2bb96e39468dce608a842fab4461429fd5a3b1318da8b7cb54",
"md5": "b8ba770ebc0e0063825b9c4faae4ceb1",
"sha256": "f1fb7d6ddd47ef11079e8953acae841d16429f34f227f373c6d6c3d7c6a17f5d"
},
"downloads": -1,
"filename": "bumpwright-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8ba770ebc0e0063825b9c4faae4ceb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 64679,
"upload_time": "2025-08-23T06:32:16",
"upload_time_iso_8601": "2025-08-23T06:32:16.482111Z",
"url": "https://files.pythonhosted.org/packages/4d/c9/823afc9c1c2bb96e39468dce608a842fab4461429fd5a3b1318da8b7cb54/bumpwright-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "02677e95c229a1bd562b20d84f6bcc488a4fc761491b49273638eab6d3fc1fe9",
"md5": "5353cc6ce85dbfd95c3c2e30e93daff0",
"sha256": "ff2f83a1ddb086740aa184dbfd81738f24c4ae61ad5b1f845e365a4a1db16593"
},
"downloads": -1,
"filename": "bumpwright-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "5353cc6ce85dbfd95c3c2e30e93daff0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 87144,
"upload_time": "2025-08-23T06:32:18",
"upload_time_iso_8601": "2025-08-23T06:32:18.139359Z",
"url": "https://files.pythonhosted.org/packages/02/67/7e95c229a1bd562b20d84f6bcc488a4fc761491b49273638eab6d3fc1fe9/bumpwright-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 06:32:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arched-dev",
"github_project": "bumpwright",
"github_not_found": true,
"lcname": "bumpwright"
}
