# bump-version-pep440
[![Code Quality](https://github.com/azataiot/python-project-template/actions/workflows/code-quality.yml/badge.svg)](https://github.com/azataiot/python-project-template/actions/workflows/code-quality.yml)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![latest release](https://img.shields.io/github/v/release/azataiot/bump-version-pep440)](https://github.com/azataiot/bump-version-pep440/releases)
**Introduction**: This project is heavily inspired by [bumpversion](https://github.com/peritus/bumpversion), yet this is
a different package with a different approach and design.
## Usage
### Quick Start
```bash
poetry add bump-version-pep440
```
### CLI Usage
```bash
❯ poetry run bv --help
Usage: bv [OPTIONS] VERSION_TYPE
Bump the version based on the provided version type and other parameters.
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * version_type TEXT [default: None] [required] │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --current-version -c TEXT Current version to be used instead of reading from pyproject.toml. [default: None] │
│ --new-version -n TEXT New version to be set instead of incrementing the current version. [default: None] │
│ --commit If set, a git commit will be created. [default: True] │
│ --commit-message TEXT Custom commit message. [default: None] │
│ --dry-run If set, no actual changes will be made, only printed. │
│ --tag If set, a git tag will be created. [default: True] │
│ --tag-name TEXT Custom tag name. [default: None] │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
## Branching Strategy
- `main`: The main branch. This branch is protected and cannot be pushed directly. (PRs must be made to `dev` instead
of `main`)
- `dev`: The development branch. This branch is protected and cannot be pushed directly. (PRs must be made to this
branch)
- `feature/*`: The 'feature/*' branches are used to develop new features for the upcoming or a distant future release.
These branches are branched off from 'dev' and must merge back into `dev`.
- `release/*`: The 'release/*' branches are used to prepare the next release. They allow for last-minute changes and
minor bug fixes. These branches are branched off from 'dev' and must merge back into `main` and `dev`.
- `hotfix/*`: The 'hotfix/*' branches are used to develop fixes for the current release. These branches are branched off
from `main` and must merge back into `main`.
## Contributing
Contributions are always welcome! Whether it's bug reports, feature requests, or pull requests, all contributions are
appreciated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).
## License
This project is licensed under some License. For more details, see [LICENSE](LICENSE.md).
## Code of Conduct
We believe in fostering an inclusive and respectful community. For guidelines and reporting information,
see [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
## Security
Your security is paramount. If you discover any security-related issues, please follow the guidelines
in [SECURITY.md](SECURITY.md).
## Founding
For information about the project's founding and backers, see [FOUNDING](https://github.com/sponsors/azataiot).
Raw data
{
"_id": null,
"home_page": "https://github.com/azataiot/bump-version-pep440",
"name": "bump-version-pep440",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Azat",
"author_email": "8280770+azataiot@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/1d/28/97c6d49d4efc4438e664a4c2cf491bf628a8df719556553bc65d02df9916/bump_version_pep440-0.0.4.post1.tar.gz",
"platform": null,
"description": "# bump-version-pep440\n\n[![Code Quality](https://github.com/azataiot/python-project-template/actions/workflows/code-quality.yml/badge.svg)](https://github.com/azataiot/python-project-template/actions/workflows/code-quality.yml)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n[![latest release](https://img.shields.io/github/v/release/azataiot/bump-version-pep440)](https://github.com/azataiot/bump-version-pep440/releases)\n\n**Introduction**: This project is heavily inspired by [bumpversion](https://github.com/peritus/bumpversion), yet this is\na different package with a different approach and design.\n\n## Usage\n\n### Quick Start\n\n```bash\npoetry add bump-version-pep440\n```\n\n### CLI Usage\n\n```bash\n\u276f poetry run bv --help\n\n Usage: bv [OPTIONS] VERSION_TYPE\n\n Bump the version based on the provided version type and other parameters.\n\n\u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * version_type TEXT [default: None] [required] \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --current-version -c TEXT Current version to be used instead of reading from pyproject.toml. [default: None] \u2502\n\u2502 --new-version -n TEXT New version to be set instead of incrementing the current version. [default: None] \u2502\n\u2502 --commit If set, a git commit will be created. [default: True] \u2502\n\u2502 --commit-message TEXT Custom commit message. [default: None] \u2502\n\u2502 --dry-run If set, no actual changes will be made, only printed. \u2502\n\u2502 --tag If set, a git tag will be created. [default: True] \u2502\n\u2502 --tag-name TEXT Custom tag name. [default: None] \u2502\n\u2502 --install-completion Install completion for the current shell. \u2502\n\u2502 --show-completion Show completion for the current shell, to copy it or customize the installation. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n## Branching Strategy\n\n- `main`: The main branch. This branch is protected and cannot be pushed directly. (PRs must be made to `dev` instead\n of `main`)\n- `dev`: The development branch. This branch is protected and cannot be pushed directly. (PRs must be made to this\n branch)\n- `feature/*`: The 'feature/*' branches are used to develop new features for the upcoming or a distant future release.\n These branches are branched off from 'dev' and must merge back into `dev`.\n- `release/*`: The 'release/*' branches are used to prepare the next release. They allow for last-minute changes and\n minor bug fixes. These branches are branched off from 'dev' and must merge back into `main` and `dev`.\n- `hotfix/*`: The 'hotfix/*' branches are used to develop fixes for the current release. These branches are branched off\n from `main` and must merge back into `main`.\n\n## Contributing\n\nContributions are always welcome! Whether it's bug reports, feature requests, or pull requests, all contributions are\nappreciated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under some License. For more details, see [LICENSE](LICENSE.md).\n\n## Code of Conduct\n\nWe believe in fostering an inclusive and respectful community. For guidelines and reporting information,\nsee [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).\n\n## Security\n\nYour security is paramount. If you discover any security-related issues, please follow the guidelines\nin [SECURITY.md](SECURITY.md).\n\n## Founding\n\nFor information about the project's founding and backers, see [FOUNDING](https://github.com/sponsors/azataiot).\n",
"bugtrack_url": null,
"license": "",
"summary": "Version-bump your software with a single command",
"version": "0.0.4.post1",
"project_urls": {
"Homepage": "https://github.com/azataiot/bump-version-pep440"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56fc02d9fac4010ada9e2e4af742e34c858771c86676e55a25d61ff930a83597",
"md5": "be019fa11068c466928e0f6856f37dfa",
"sha256": "41a6e23c90b7f51ac1ae9a3302cd73f7757f4b34652f995c9bb4b0040af84f83"
},
"downloads": -1,
"filename": "bump_version_pep440-0.0.4.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be019fa11068c466928e0f6856f37dfa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 7248,
"upload_time": "2023-09-11T16:45:15",
"upload_time_iso_8601": "2023-09-11T16:45:15.592127Z",
"url": "https://files.pythonhosted.org/packages/56/fc/02d9fac4010ada9e2e4af742e34c858771c86676e55a25d61ff930a83597/bump_version_pep440-0.0.4.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d2897c6d49d4efc4438e664a4c2cf491bf628a8df719556553bc65d02df9916",
"md5": "6e04657c51e40165cb21ab5f68553803",
"sha256": "2645b4aef1eb2f3c7319492d45fcfe901609f04b27d432e1b42bf2da66126d33"
},
"downloads": -1,
"filename": "bump_version_pep440-0.0.4.post1.tar.gz",
"has_sig": false,
"md5_digest": "6e04657c51e40165cb21ab5f68553803",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 5530,
"upload_time": "2023-09-11T16:45:16",
"upload_time_iso_8601": "2023-09-11T16:45:16.598721Z",
"url": "https://files.pythonhosted.org/packages/1d/28/97c6d49d4efc4438e664a4c2cf491bf628a8df719556553bc65d02df9916/bump_version_pep440-0.0.4.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-11 16:45:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "azataiot",
"github_project": "bump-version-pep440",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bump-version-pep440"
}