| Name | bumpwright JSON |
| Version |
7.2.0
JSON |
| download |
| home_page | None |
| Summary | Static public-API diff + heuristics to suggest semantic version bumps. |
| upload_time | 2025-08-17 19:39:02 |
| 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 compares two Git refs, inspects your **public API**, and recommends (or applies) the correct semantic version bump. It can also update version strings in your project and render changelog entries from your commits.
**Docs:** https://lewis-morris.github.io/bumpwright
---
## Why Bumpwright?
- **Code-first accuracy** – infers breaking/minor/patch from exported symbols, not commit messages.
- **Optional analysers** – enable checks for CLI, web routes, migrations, OpenAPI/GraphQL, and more.
- **CI-friendly** – print a decision (`text|md|json`) or apply + tag releases automatically.
Get started in the [Introduction](https://lewis-morris.github.io/bumpwright/#introduction) or dive into the [Quickstart](https://lewis-morris.github.io/bumpwright/get-started.html#quickstart).
---
## 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/get-started.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/get-started.html#quickstart) • 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 = ["."]
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.
- **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/dd/ca/923963c0b1ff5b3b9b21093475ed282d8869bfa6ed38607d6cde908f221f/bumpwright-7.2.0.tar.gz",
"platform": null,
"description": "# bumpwright\n\n\n\n\n\n\nBumpwright compares two Git refs, inspects your **public API**, and recommends (or applies) the correct semantic version bump. It can also update version strings in your project and render changelog entries from your commits.\n\n**Docs:** https://lewis-morris.github.io/bumpwright\n\n---\n\n## Why Bumpwright?\n\n- **Code-first accuracy** \u2013 infers breaking/minor/patch from exported symbols, not commit messages. \n- **Optional analysers** \u2013 enable checks for CLI, web routes, migrations, OpenAPI/GraphQL, and more.\n- **CI-friendly** \u2013 print a decision (`text|md|json`) or apply + tag releases automatically.\n\nGet started in the [Introduction](https://lewis-morris.github.io/bumpwright/#introduction) or dive into the [Quickstart](https://lewis-morris.github.io/bumpwright/get-started.html#quickstart).\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/get-started.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/get-started.html#quickstart) \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 = [\".\"]\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- **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": "7.2.0",
"project_urls": {
"bug_tracker": "https://github.com/arched-dev/bumpwright/issues",
"documentation": "https://bumpwright.readthedocs.io",
"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": "1c79f255afb3bf459bbd607f692ba4d0a55bed9cb96bbe13e40df376beaf1e79",
"md5": "acfd7f4e6b95eb234507945227694009",
"sha256": "7759e68e5a5293c019cff9cba7a53c551aa5eeaa9d6d6a57068964003535cc98"
},
"downloads": -1,
"filename": "bumpwright-7.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acfd7f4e6b95eb234507945227694009",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 57087,
"upload_time": "2025-08-17T19:39:01",
"upload_time_iso_8601": "2025-08-17T19:39:01.359849Z",
"url": "https://files.pythonhosted.org/packages/1c/79/f255afb3bf459bbd607f692ba4d0a55bed9cb96bbe13e40df376beaf1e79/bumpwright-7.2.0-py3-none-any.whl",
"yanked": true,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ddca923963c0b1ff5b3b9b21093475ed282d8869bfa6ed38607d6cde908f221f",
"md5": "80305b74f3c0f65f3dd355c790f7a092",
"sha256": "4aba32e1b4f3a4a7b536c65ccefa2f41c9a0393f4fd88e6c63381ab8e184adab"
},
"downloads": -1,
"filename": "bumpwright-7.2.0.tar.gz",
"has_sig": false,
"md5_digest": "80305b74f3c0f65f3dd355c790f7a092",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 75300,
"upload_time": "2025-08-17T19:39:02",
"upload_time_iso_8601": "2025-08-17T19:39:02.909856Z",
"url": "https://files.pythonhosted.org/packages/dd/ca/923963c0b1ff5b3b9b21093475ed282d8869bfa6ed38607d6cde908f221f/bumpwright-7.2.0.tar.gz",
"yanked": true,
"yanked_reason": null
}
],
"upload_time": "2025-08-17 19:39:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arched-dev",
"github_project": "bumpwright",
"github_not_found": true,
"lcname": "bumpwright"
}
