Package: poetry-scmver
Dynamic versioning plugin for PoetryThis package is a plugin forPoetryto enable dynamic versioning based on tags in your version control system,
powered byScmver.Since Poetry does not yet officially support plugins
(refer tothis issue)
as of the time of writing on 2019-12-10, 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.InstallationPython 3.5 (or newer) and Poetry 0.12.1 (or newer) are required.Runpip install poetry-scmverAdd this to your pyproject.toml:[tool.scmver]enable=trueNote that you must install the plugin in your global Python installation,notas a dependency in pyroject.toml, because the virtual environment
that Poetry creates cannot see Poetry itself and therefore cannot patch it.ConfigurationIn your pyproject.toml file, you may configure the following options:[tool.scmver]: 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.root: A path of the working directory. Default:'.'spec: A version specifier to construct the public version indentifiers. It will be incremented by the number of commits from the latest tag.major: It will increment the major version.minor: It will increment the minor version.microorpatch: It will increment the micro (patch) version.post: It will increment the post-release segment.major.dev: It will increment the development release segment after incrementing the major version by 1.minor.dev: It will increment the development release segment after incrementing the minor version by 1.micro.devorpatch.dev: It will increment the development release segment after incrementing the micro (patch) version by 1.Default:'post'local: Astringto construct the local version identifiers.Available keywords:{distance}{reivison}{branch}{utc}- Return value ofdatetime.datetime.utcnow(){local}- Return value ofdatetime.datetime.now()Default:'{local:%Y-%m-%d}'version: A regular expression object to extract the version from SCM tags. It should contain the version group.write_to: A path to a file which will be generated usingtemplate.template: A format string which is used bywrite_to.
Available keywords:{version}{revision}{branch}bazaar.tag: A regular expression pattern to filter tags.fossil.tag: A regular expression pattern to filter tags.git.tag: It will be passed togit describeas--match.mercurial.tag: A regular expression pattern to filter tags.subversion.tag: A regular expression pattern to filter tags.subversion.trunk: A relative repository path of the trunk directory. Default:'trunk'`subversion.branches: A relative repository path of the directory where branches are located. Default:'branches'subversion.tags: A relative repository path of the directory where tags are located. Default:'tags'Simple example:[tool.semver]enable=truewrite_to="version.py"ImplementationIn order to side-load plugin functionality into Poetry, this package
does the following:Upon installation, it delivers azzz_poetry_semver.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 tozzz).It patchesbuiltins.__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 ofpoetry.console.mainwill then, when called,
additionally patch eitherpoetry.poetry.Poetry.create()orpoetry.factory.Factory.create_poetry()(depending on your Poetry version)
to replace the version from your pyproject.toml file with the dynamically
generated version.ChangelogSeeChangelogLicenseSeeLicense