semversion


Namesemversion JSON
Version 2.0.3 PyPI version JSON
download
home_pagehttps://github.com/gadc1996/semversion
SummaryManage project semantic version.
upload_time2023-11-26 16:52:08
maintainer
docs_urlNone
authorGabriel Delgado
requires_python
license
keywords
VCS
bugtrack_url
requirements click coverage semversion
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Semversion
## Python Semantic Versioning Tool
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/gadc1996/python-workspace)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Test](https://github.com/gadc1996/semversion/actions/workflows/test.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/test.yml)
[![Lint](https://github.com/gadc1996/semversion/actions/workflows/lint.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/lint.yml)
[![Deploy to PyPI](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi.yml)
[![Deploy to PyPI Test](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi_test.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi_test.yml)


`semversion` is a Python module designed to manage and easily modify semantic versions of your projects. With this tool, you can keep a version log and update it as needed.

### Installation

You can install `semversion` using pip:

```bash
$ pip install semversion
```

Running this command for the first time promts for the creation of the `.version` file if it doesnt exists.

Version file can be modified using envirment variable `SEMVERSION_FILE`

### Basic Usage
`semversion` can be used as a standalone python module, mainly for scripting.

```bash
$ python -m semversion <version_part>
```

### Example Usage
```python
from semversion import version, increment, initialize, SEMVERSION_FILE, MAJOR, MINOR, PATCH

# Get the current version
current_version = version()
print(f"Current version: {current_version}")

# Increment the minor version
new_version = increment(MINOR)
print(f"New version: {new_version}")
```


### Contribute

Feel free to contribute! Open an issue or send a pull request.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gadc1996/semversion",
    "name": "semversion",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Gabriel Delgado",
    "author_email": "gadc1996@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/23/43/d0b30ac91a89b6a51b545d8ba030becb4e4402b9c163f8c828b2de2a434e/semversion-2.0.3.tar.gz",
    "platform": null,
    "description": "# Semversion\n## Python Semantic Versioning Tool\n[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/gadc1996/python-workspace)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Test](https://github.com/gadc1996/semversion/actions/workflows/test.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/test.yml)\n[![Lint](https://github.com/gadc1996/semversion/actions/workflows/lint.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/lint.yml)\n[![Deploy to PyPI](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi.yml)\n[![Deploy to PyPI Test](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi_test.yml/badge.svg)](https://github.com/gadc1996/semversion/actions/workflows/deploy_pypi_test.yml)\n\n\n`semversion` is a Python module designed to manage and easily modify semantic versions of your projects. With this tool, you can keep a version log and update it as needed.\n\n### Installation\n\nYou can install `semversion` using pip:\n\n```bash\n$ pip install semversion\n```\n\nRunning this command for the first time promts for the creation of the `.version` file if it doesnt exists.\n\nVersion file can be modified using envirment variable `SEMVERSION_FILE`\n\n### Basic Usage\n`semversion` can be used as a standalone python module, mainly for scripting.\n\n```bash\n$ python -m semversion <version_part>\n```\n\n### Example Usage\n```python\nfrom semversion import version, increment, initialize, SEMVERSION_FILE, MAJOR, MINOR, PATCH\n\n# Get the current version\ncurrent_version = version()\nprint(f\"Current version: {current_version}\")\n\n# Increment the minor version\nnew_version = increment(MINOR)\nprint(f\"New version: {new_version}\")\n```\n\n\n### Contribute\n\nFeel free to contribute! Open an issue or send a pull request.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Manage project semantic version.",
    "version": "2.0.3",
    "project_urls": {
        "Homepage": "https://github.com/gadc1996/semversion"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "31b3eb7d38683a2bfafcab8e97a8d4d07b99b4d66b02dbde7524df9ea14c4f49",
                "md5": "06e66e57a575d1a9ba6c61883372710a",
                "sha256": "797bf7e2efd05da745b0408d7ade45147584a93501a6b307dd1a9aa85bd9ae31"
            },
            "downloads": -1,
            "filename": "semversion-2.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "06e66e57a575d1a9ba6c61883372710a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5395,
            "upload_time": "2023-11-26T16:52:07",
            "upload_time_iso_8601": "2023-11-26T16:52:07.244515Z",
            "url": "https://files.pythonhosted.org/packages/31/b3/eb7d38683a2bfafcab8e97a8d4d07b99b4d66b02dbde7524df9ea14c4f49/semversion-2.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2343d0b30ac91a89b6a51b545d8ba030becb4e4402b9c163f8c828b2de2a434e",
                "md5": "4b56a26831fcb1b36aac5d16c5077f59",
                "sha256": "9e73b4f7e03ff696aac957a6a6ca22501b08902bf835624588a5901065fdc45c"
            },
            "downloads": -1,
            "filename": "semversion-2.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4b56a26831fcb1b36aac5d16c5077f59",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3700,
            "upload_time": "2023-11-26T16:52:08",
            "upload_time_iso_8601": "2023-11-26T16:52:08.905292Z",
            "url": "https://files.pythonhosted.org/packages/23/43/d0b30ac91a89b6a51b545d8ba030becb4e4402b9c163f8c828b2de2a434e/semversion-2.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-26 16:52:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gadc1996",
    "github_project": "semversion",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "click",
            "specs": [
                [
                    "==",
                    "8.1.7"
                ]
            ]
        },
        {
            "name": "coverage",
            "specs": [
                [
                    "==",
                    "7.3.2"
                ]
            ]
        },
        {
            "name": "semversion",
            "specs": [
                [
                    "==",
                    "1.2.0"
                ]
            ]
        }
    ],
    "lcname": "semversion"
}
        
Elapsed time: 0.33842s