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}'"
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}'"
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.1a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 628dd24f4456552330f3844e2b1fb48cfbe8ba213d44f2464c90edce75037e39 |
|
MD5 | 7373ea7d3fb517c596d7ee5b470097cf |
|
BLAKE2b-256 | c5cbfea836a6dc58c18e252c952c8514773b9eff7a5abe635056628c6018c63d |
Hashes for proman_versioning-0.4.1a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d86b5466622b68eae4c1c0a1c37f1ddde148944bff0fb6602a8396025c6ac02 |
|
MD5 | cac9adbd490dde3c96483737e84624aa |
|
BLAKE2b-256 | d12f9e2aedb60cc01cc8eead5b713be37c0a65011e6ffd8e201913407b8ebca0 |