Project Management 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"
Example .version
configuration
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.
version = "1.2.3"
[[versioning.files]]
filepath = "example/__init__.py"
pattern = "__version__ = '${version}'"
[[versioning.files]]
filepath = "chart/Chart.yaml"
patterns = [
"version = \"${version}\"",
"appVersion = \"${version}\""
]
Example pyproject.toml
[project]
name = "example"
version = "1.2.3"
[tool.proman.versioning]
compat = "semver"
[[tool.proman.versioning.files]]
filepath = "example/__init__.py"
pattern = "__version__ = '${version}'"
[[tool.proman.versioning.files]]
filepath = "chart/Chart.yaml"
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.7.1a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62b68c7be10b42516a940add44e7696479004721aca83646145206759a0324ea |
|
MD5 | 932ab16704d6a8293f74cfdeb4b82b56 |
|
BLAKE2b-256 | 67a2598be6f5c14b33482464fddeac332ab0660406ed5f355c4d05acaddabd96 |
Hashes for proman_versioning-0.7.1a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26d477b398691098ec654f06699d91ed229ff8043676f38f23e6041fbaaee982 |
|
MD5 | b594621b733fd7945719eb39e816178e |
|
BLAKE2b-256 | b45b4bd7370604e48e6945b8a9d4888ead8f52bff8dd4a58fb3b2d4fffc9c044 |