Project Manager Versioning tool.
Project description
Proman Versioning
Overview
Project Manager Versioning is a PEP-440 compliant tool for automating project versions using conventional commits.
Install
pip install proman-versioning
Setup
This tool is designed to work with any textfile using a templating pattern and path to the file.
Configuring versions
Configuration can be performed with either the .versioning
or pyproject.toml
files.
Global configuration settings:
Specific types of releases can be disabled by setting the respective release to false.
Disable development releases:
enable_devreleases = false
Disable pre-releases:
enable_prereleases = false
Disable post-releases:
enable_postreleases = false
File specific settings:
Use different version compatibiliy type:
compat = "semver"
Update only the release version for a configuration:
release_only = true
Example .versioning
The .versioning
config is a non-specfile based project file using TOML. This is the
preferred configuration for non-python projects that may use this tool.
[proman]
version = "1.2.3"
[proman.versioning]
disable_devreleases = true
[[tool.proman.versioning.files]]
filepath = "pyproject.toml"
pattern = "version = \"${version}\""
[[proman.versioning.files]]
filepath = "example/__init__.py"
pattern = "__version__ = '${version}'"
[[tool.proman.versioning.files]]
filepath = "chart/Chart.yaml"
compat = "semver"
patterns = [
"version = \"${version}\"",
"appVersion = \"${version}\""
]
Example pyproject.toml
[tool.proman]
version = "1.2.3"
[tool.proman.versioning]
[[tool.proman.versioning.files]]
filepath = "pyproject.toml"
pattern = "version = \"${version}\""
[[tool.proman.versioning.files]]
filepath = "example/__init__.py"
pattern = "__version__ = '${version}'"
[[tool.proman.versioning.files]]
filepath = "chart/Chart.yaml"
compat = "semver"
patterns = [
"version = \"${version}\"",
"appVersion = \"${version}\""
]
Example setup.cfg
Setuptools allows setup.cfg
to pull the version from the application. This
should be used in tandem with either of the above configurations to control
versions for a project.
[metadata]
name = example
version = attr: src.VERSION
...
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for proman-versioning-0.4.3a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ab2cdbacd6e2c66bf66d4f75e112fe9da9d70cdcc7f712068f78a3a26aa1239 |
|
MD5 | 6c4a9e7c4225729b105927ce6371fa69 |
|
BLAKE2b-256 | 7ec6af2b9260d8f76585a51fccc44e2860eb2b6a19f96477437a66a55ccfd18d |
Hashes for proman_versioning-0.4.3a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 140ad7198ec86b6866557ee88a9ed511ad392262a4ac12ea7f7b6f005001a753 |
|
MD5 | bc7cb023fd734834debbea3074ebab61 |
|
BLAKE2b-256 | 79250ac12bb3787ff45bcfcf4c14ce1054b5423f993b644e2f11c5503d22cebb |