# 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-arbitrary-version-plugin",
"name": "poetry-arbitrary-version-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4",
"maintainer_email": "",
"keywords": "poetry,poetry-plugin,plugin,version,arbitrary-version",
"author": "Michal Nowikowski",
"author_email": "godfryd@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/65/47/f4f362acd99107d3ab5b2541e0a987126f2cd2021749dec2f9199d40f855/poetry_arbitrary_version_plugin-0.9.2.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.9.2",
"project_urls": {
"Homepage": "https://github.com/godfryd/poetry-arbitrary-version-plugin",
"Repository": "https://github.com/godfryd/poetry-arbitrary-version-plugin"
},
"split_keywords": [
"poetry",
"poetry-plugin",
"plugin",
"version",
"arbitrary-version"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2be0074d05d8c21668a2268a0af50995a67896b273b47e63645501d62450b057",
"md5": "c0cca13f862ad48e279957a0b5c0f770",
"sha256": "37192a908659e7962d541bcf82cb2fc0d767987133cdde6feaa9d5e9ef9bea89"
},
"downloads": -1,
"filename": "poetry_arbitrary_version_plugin-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0cca13f862ad48e279957a0b5c0f770",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4",
"size": 7648,
"upload_time": "2022-11-12T11:42:12",
"upload_time_iso_8601": "2022-11-12T11:42:12.989075Z",
"url": "https://files.pythonhosted.org/packages/2b/e0/074d05d8c21668a2268a0af50995a67896b273b47e63645501d62450b057/poetry_arbitrary_version_plugin-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6547f4f362acd99107d3ab5b2541e0a987126f2cd2021749dec2f9199d40f855",
"md5": "6ccea202ccc66ac4d897a72ff0df55b9",
"sha256": "2ca439ced9dd5cb391b295dd8554c723903dba6ee39189096f6165ad59702142"
},
"downloads": -1,
"filename": "poetry_arbitrary_version_plugin-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "6ccea202ccc66ac4d897a72ff0df55b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4",
"size": 6836,
"upload_time": "2022-11-12T11:42:14",
"upload_time_iso_8601": "2022-11-12T11:42:14.563822Z",
"url": "https://files.pythonhosted.org/packages/65/47/f4f362acd99107d3ab5b2541e0a987126f2cd2021749dec2f9199d40f855/poetry_arbitrary_version_plugin-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-12 11:42:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "godfryd",
"github_project": "poetry-arbitrary-version-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "poetry-arbitrary-version-plugin"
}