Dynamic versioning plugin for Poetry
Since Poetry does not yet officially support plugins (refer to this issue) as of the time of writing on 2019-06-04, this package takes some novel liberties to make the functionality possible. As soon as official support lands, this plugin will be updated to do things the official way.
Python 3.5 or newer is required.
pip install poetry-dynamic-versioning
- Add this to your pyproject.toml:
[tool.poetry-dynamic-versioning] enable = true
Note that you must install the plugin in your global Python installation, not as a dependency in pyroject.toml, because the virtual environment that Poetry creates cannot see Poetry itself and therefore cannot patch it.
In your pyproject.toml file, you may configure the following options:
[tool.poetry-dynamic-versioning]: General options.
enable: Boolean. Default: false. Since the plugin has to be installed globally, this setting is an opt-in per project. This setting will likely be removed once plugins are officially supported.
vcs: String. This is the version control system to check for a version. One of:
metadata: Boolean. Default: unset. If true, include the commit hash in the version, and also include a dirty flag if
dirtyis true. If unset, metadata will only be included if you are on a commit without a version tag.
dirty: Boolean. Default: false. If true, include a dirty flag in the metadata, indicating whether there are any uncommitted changes.
pattern: String. This is a regular expression which will be used to find a tag representing a version. There must be a named capture group
basewith the main part of the version, and optionally you can also have groups named
pre_numberfor prereleases. The default is
format: String. Default: unset. This defines a custom output format for the version. Available substitutions:
style: String. Default: unset. One of:
pvp. These are preconfigured output formats. If you set both a
format, then the format will be validated against the style's rules. If
styleis unset, the default output format will follow PEP 440, but a custom
formatwill only be validated if
styleis set explicitly.
latest-tag: Boolean. Default: false. If true, then only check the latest tag for a version, rather than looking through all the tags until a suitable one is found to match the
[tool.poetry-dynamic-versioning.subversion]: Options specific to Subversion.
tag-dir: String. Default:
tags. This is the location of tags relative to the root.
[tool.poetry-dynamic-versioning] enable = true vcs = "git" style = "semver"
In order to side-load plugin functionality into Poetry, this package does the following:
- Upon installation, it delivers a
zzz_poetry_dynamic_versioning.pthfile to your Python site-packages directory. This forces Python to automatically load the plugin after all other modules have been loaded (or at least those alphabetically prior to
- It patches
builtins.__import__so that, whenever the first import from Poetry finishes,
poetry.console.mainwill be patched. The reason we have to wait for a Poetry import is in case you've used the get-poetry.py script, in which case there is a gap between when Python is fully loaded and when
~/.poetry/bin/poetryadds the Poetry lib folder to the PYTHONPATH.
- The patched version of
poetry.console.mainwill then, when called, additionally patch
poetry.poetry.Poetry.createto replace the version from your pyproject.toml file with the dynamically generated version.
- If you want to take advantage of the default VSCode integration, then first
configure Poetry to make its virtual environment in the repository:
poetry config settings.virtualenvs.in-project true
- After cloning the repository, activate the tooling:
poetry install poetry run pre-commit install
- Run unit tests:
poetry run pytest --cov poetry run tox
- Run integration tests:
Git Bash is recommended for Windows.