| Name | bump2v JSON |
| Version |
1.1.8
JSON |
| download |
| home_page | None |
| Summary | This is a package to bump version numbers in a project. Fully automated versioning. Prefer to bump2version package instructions. |
| upload_time | 2024-10-23 07:12:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2024 Mr Nachos 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 |
alternative
version
versioning
bump2version
automate
python
deployment
devops
dev
ops
automation
bump
versioning
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Quick Start | How to Setup/Run
================================
For first-time users, please download the `bump2v <https://pypi.org/project/bump2v/>`_ package as shown below:
.. code-block:: zsh
pip install bump2v
---------------------------
**Step 1:** Make a Code Change
**Step 2:** Stage and Commit the Changes
You may stage and commit using the GUI method or the command line as shown below:
.. code-block:: zsh
git add .
git commit -m "Describe your changes here"
**Step 3:** Assign the Tag 🏷️ and Push to GitHub
**Example:**
.. code-block:: zsh
bump2v patch
.. code-block:: zsh
bump2v minor
.. code-block:: zsh
bump2v major
- **v0.0.1** 👈🏻 **Patch Version:** This is typically reserved for bug fixes or minor improvements that are backward-compatible with the existing features.
- **v0.1.0** 👈🏻 **Minor Version:** Reflects smaller, backward-compatible enhancements and features added to the software.
- **v1.0.0** 👈🏻 **Major Version:** Indicates significant, potentially backward-incompatible changes to the software.
**Note:** _Always use 'v' before the version number._ **vX.X.X** This type of versioning is called Semantic Versioning (SemVer).
To learn more about Semantic Versioning, `click here <https://www.geeksforgeeks.org/introduction-semantic-versioning/>`_.
--------
For a new project, you need the following configuration:
**Step 1:** Create a **.bumpversion.cfg** file and an **appInfo.py** file.
**Step 2:** Populate the **.bumpversion.cfg** file with the data below:
.. code-block:: ini
[bumpversion]
current_version = 0.0.1
commit = False
tag = True
TAG_NAME = {new_version}
TAG_MESSAGE = "Release {new_version}: Changelog: {changelog}"
[bumpversion:file:app/appInfo.py] # <- location to your appInfo.py file. Example: app/appInfo.py or appInfo.py
**Step 3:** Populate **appInfo.py** with information about your app as shown below:
.. code-block:: python
# File: app/appInfo.py
app_name = "Your App Name"
__version__ = "v0.0.1" # Initial version, leave as it is.
description = "Describe your app here"
tags_metadata = "tags metadata here"
**Step 4:** Import **appInfo.py** to your **main.py** and use the variables from **appInfo.py** to assign your version, app name, and description as shown below:
.. code-block:: python
from appInfo import __version__, app_name, description, tags_metadata
from fastapi import FastAPI
app = FastAPI(
title=app_name,
description=description,
version=f" 🏭 Prod:{__version__} ",
openapi_tags=tags_metadata
)
PS. 👾 **Fun Tip:** 👾 You can use alternative commands like **versionkaboom**, **bismillah**, or **bumptydumpty** instead of bump2v.
**Example:**
.. code-block:: zsh
versionkaboom patch
.. code-block:: zsh
bismillah patch
.. code-block:: zsh
bumptydumpty patch
This release of the `bump2v` package brings a set of enhancements, bug fixes, and new features aimed at improving functionality and user experience. The version is deemed production-ready.
## Readiness for Production
This version has undergone thorough testing and is considered stable for production use.
## Upgrade Instructions
If you are upgrading from a previous version, please follow the upgrade instructions in the `documentation <link-to-docs>`_.
## Contributors
This package is built on top of Bump2version. A sincere thank you to all contributors who participated in making this release possible.
Raw data
{
"_id": null,
"home_page": null,
"name": "bump2v",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "alternative, version, versioning, bump2version, automate, python, deployment, devops, dev, ops, automation, bump, versioning",
"author": null,
"author_email": null,
"download_url": null,
"platform": null,
"description": "Quick Start | How to Setup/Run\n================================\n\nFor first-time users, please download the `bump2v <https://pypi.org/project/bump2v/>`_ package as shown below:\n\n.. code-block:: zsh\n\n pip install bump2v\n\n---------------------------\n\n**Step 1:** Make a Code Change\n\n**Step 2:** Stage and Commit the Changes\n\nYou may stage and commit using the GUI method or the command line as shown below:\n\n.. code-block:: zsh\n\n git add .\n git commit -m \"Describe your changes here\"\n\n**Step 3:** Assign the Tag \ud83c\udff7\ufe0f and Push to GitHub\n\n**Example:**\n\n.. code-block:: zsh\n\n bump2v patch\n\n.. code-block:: zsh\n\n bump2v minor\n\n.. code-block:: zsh\n\n bump2v major\n\n- **v0.0.1** \ud83d\udc48\ud83c\udffb **Patch Version:** This is typically reserved for bug fixes or minor improvements that are backward-compatible with the existing features.\n- **v0.1.0** \ud83d\udc48\ud83c\udffb **Minor Version:** Reflects smaller, backward-compatible enhancements and features added to the software.\n- **v1.0.0** \ud83d\udc48\ud83c\udffb **Major Version:** Indicates significant, potentially backward-incompatible changes to the software.\n\n**Note:** _Always use 'v' before the version number._ **vX.X.X** This type of versioning is called Semantic Versioning (SemVer).\nTo learn more about Semantic Versioning, `click here <https://www.geeksforgeeks.org/introduction-semantic-versioning/>`_.\n\n--------\n\nFor a new project, you need the following configuration:\n\n**Step 1:** Create a **.bumpversion.cfg** file and an **appInfo.py** file.\n\n**Step 2:** Populate the **.bumpversion.cfg** file with the data below:\n\n.. code-block:: ini\n\n [bumpversion]\n current_version = 0.0.1\n commit = False\n tag = True\n TAG_NAME = {new_version}\n TAG_MESSAGE = \"Release {new_version}: Changelog: {changelog}\"\n\n [bumpversion:file:app/appInfo.py] # <- location to your appInfo.py file. Example: app/appInfo.py or appInfo.py\n\n**Step 3:** Populate **appInfo.py** with information about your app as shown below:\n\n.. code-block:: python\n\n # File: app/appInfo.py\n app_name = \"Your App Name\"\n __version__ = \"v0.0.1\" # Initial version, leave as it is.\n description = \"Describe your app here\"\n tags_metadata = \"tags metadata here\"\n\n**Step 4:** Import **appInfo.py** to your **main.py** and use the variables from **appInfo.py** to assign your version, app name, and description as shown below:\n\n.. code-block:: python\n\n from appInfo import __version__, app_name, description, tags_metadata\n from fastapi import FastAPI\n\n app = FastAPI(\n title=app_name,\n description=description,\n version=f\" \ud83c\udfed Prod:{__version__} \",\n openapi_tags=tags_metadata\n )\n\nPS. \ud83d\udc7e **Fun Tip:** \ud83d\udc7e You can use alternative commands like **versionkaboom**, **bismillah**, or **bumptydumpty** instead of bump2v.\n\n**Example:**\n\n.. code-block:: zsh\n\n versionkaboom patch\n\n.. code-block:: zsh\n\n bismillah patch\n\n.. code-block:: zsh\n\n bumptydumpty patch\n\nThis release of the `bump2v` package brings a set of enhancements, bug fixes, and new features aimed at improving functionality and user experience. The version is deemed production-ready.\n\n## Readiness for Production\n\nThis version has undergone thorough testing and is considered stable for production use.\n\n## Upgrade Instructions\n\nIf you are upgrading from a previous version, please follow the upgrade instructions in the `documentation <link-to-docs>`_.\n\n## Contributors\n\nThis package is built on top of Bump2version. A sincere thank you to all contributors who participated in making this release possible.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Mr Nachos 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. ",
"summary": "This is a package to bump version numbers in a project. Fully automated versioning. Prefer to bump2version package instructions.",
"version": "1.1.8",
"project_urls": {
"Homepage": "https://github.com/maimul/bump2v"
},
"split_keywords": [
"alternative",
" version",
" versioning",
" bump2version",
" automate",
" python",
" deployment",
" devops",
" dev",
" ops",
" automation",
" bump",
" versioning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15d1c8fc10abc22d55ce9e75dcdaab0648ae2631bcaa6a788d703b2bae8d6d7c",
"md5": "9fa53b6edea3ffa5fba973d1f0ce365c",
"sha256": "77acee7b1c93cbae652994e979f46235f1a87e99b3f3677cbb8f4c4ff4b1d453"
},
"downloads": -1,
"filename": "bump2v-1.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9fa53b6edea3ffa5fba973d1f0ce365c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6179,
"upload_time": "2024-10-23T07:12:39",
"upload_time_iso_8601": "2024-10-23T07:12:39.485074Z",
"url": "https://files.pythonhosted.org/packages/15/d1/c8fc10abc22d55ce9e75dcdaab0648ae2631bcaa6a788d703b2bae8d6d7c/bump2v-1.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 07:12:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maimul",
"github_project": "bump2v",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bump2v"
}
