# Poetry Arbitrary Version Plugin
[![CI](https://github.com/godfryd/poetry-arbitrary-version-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/godfryd/poetry-arbitrary-version-plugin/actions/workflows/build.yml)
A [Poetry](https://python-poetry.org/) plugin that allows a project
builder to override the project version. A project version can be
overriden for example during CI process. The version can be overriden
using the environment variable `PROJECT_OVERRIDE_VERSION` or
the `--override-version` switch of the build command.
## Install
Add the plugin to Poetry environment
```sh
$ poetry self add poetry-arbitrary-version-plugin
```
or install the plugin using `pip` to the place where `Poetry` is installed.
```sh
$ pip install poetry-arbitrary-version-plugin
```
## Usage
Overriding a project version by `PROJECT_OVERRIDE_VERSION` environment variable:
```console
$ PROJECT_OVERRIDE_VERSION=3.2.1 poetry build -f sdist
Overriden project version from 0.8.0 to 3.2.1
Building poetry-arbitrary-version-plugin (3.2.1)
- Building sdist
- Built poetry_arbitrary_version_plugin-3.2.1.tar.gz
```
Overriding a project version by the `--override-version` switch:
```console
$ poetry build -f sdist --override-version=1.2.3
Overriden project version from 0.8.0 to 1.2.3
Building poetry-arbitrary-version-plugin (1.2.3)
- Building sdist
- Built poetry_arbitrary_version_plugin-1.2.3.tar.gz
```
Raw data
{
"_id": null,
"home_page": "https://github.com/godfryd/poetry-version-override-plugin",
"name": "poetry-version-override-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "poetry,poetry-plugin,plugin,version,version-override",
"author": "Michal Nowikowski",
"author_email": "godfryd@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fb/c7/b4c77c64cd6f6f1bf0b8092bdee3cdb6023acedc776b2c420931ff14090d/poetry_version_override_plugin-0.1.4.tar.gz",
"platform": null,
"description": "# Poetry Arbitrary Version Plugin\n\n[![CI](https://github.com/godfryd/poetry-arbitrary-version-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/godfryd/poetry-arbitrary-version-plugin/actions/workflows/build.yml)\n\nA [Poetry](https://python-poetry.org/) plugin that allows a project\nbuilder to override the project version. A project version can be\noverriden for example during CI process. The version can be overriden\nusing the environment variable `PROJECT_OVERRIDE_VERSION` or\nthe `--override-version` switch of the build command.\n\n## Install\n\nAdd the plugin to Poetry environment\n\n```sh\n$ poetry self add poetry-arbitrary-version-plugin\n```\n\nor install the plugin using `pip` to the place where `Poetry` is installed.\n\n```sh\n$ pip install poetry-arbitrary-version-plugin\n```\n\n## Usage\n\nOverriding a project version by `PROJECT_OVERRIDE_VERSION` environment variable:\n\n```console\n$ PROJECT_OVERRIDE_VERSION=3.2.1 poetry build -f sdist\nOverriden project version from 0.8.0 to 3.2.1\nBuilding poetry-arbitrary-version-plugin (3.2.1)\n - Building sdist\n - Built poetry_arbitrary_version_plugin-3.2.1.tar.gz\n```\n\nOverriding a project version by the `--override-version` switch:\n\n```console\n$ poetry build -f sdist --override-version=1.2.3\nOverriden project version from 0.8.0 to 1.2.3\nBuilding poetry-arbitrary-version-plugin (1.2.3)\n - Building sdist\n - Built poetry_arbitrary_version_plugin-1.2.3.tar.gz\n```\n",
"bugtrack_url": null,
"license": "APACHE 2.0",
"summary": "A Poetry plugin to override a version in a pyproject.toml from environment variable or build and publish command option",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/godfryd/poetry-version-override-plugin",
"Repository": "https://github.com/godfryd/poetry-version-override-plugin"
},
"split_keywords": [
"poetry",
"poetry-plugin",
"plugin",
"version",
"version-override"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "351c93dcf069cbd8cd1ab45f2c892d76483fc0e1f0475b8f13cb55ec305c096d",
"md5": "adf57895beb2e1700ebf1712db38913b",
"sha256": "2f9376a424135031acfa5666525a899a7ca578b1e6b220663ec20618a1941e51"
},
"downloads": -1,
"filename": "poetry_version_override_plugin-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adf57895beb2e1700ebf1712db38913b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 7638,
"upload_time": "2024-01-15T01:30:15",
"upload_time_iso_8601": "2024-01-15T01:30:15.326431Z",
"url": "https://files.pythonhosted.org/packages/35/1c/93dcf069cbd8cd1ab45f2c892d76483fc0e1f0475b8f13cb55ec305c096d/poetry_version_override_plugin-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fbc7b4c77c64cd6f6f1bf0b8092bdee3cdb6023acedc776b2c420931ff14090d",
"md5": "9b596c1064e10704ab164772cdec5c8d",
"sha256": "20184a38f21eaf78d6b7be763b28940b61592568160508477d5733e333498294"
},
"downloads": -1,
"filename": "poetry_version_override_plugin-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "9b596c1064e10704ab164772cdec5c8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 6629,
"upload_time": "2024-01-15T01:30:17",
"upload_time_iso_8601": "2024-01-15T01:30:17.139202Z",
"url": "https://files.pythonhosted.org/packages/fb/c7/b4c77c64cd6f6f1bf0b8092bdee3cdb6023acedc776b2c420931ff14090d/poetry_version_override_plugin-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 01:30:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "godfryd",
"github_project": "poetry-version-override-plugin",
"github_not_found": true,
"lcname": "poetry-version-override-plugin"
}