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"
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
[[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.7.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2bec6eef09ad1a40110ffa1557ab7509569f106384119080ce658409f419204 |
|
MD5 | d15ea4fd5cd2181d7b69b51e77b809d1 |
|
BLAKE2b-256 | c83a9282a1676c621bedc21dbabd75589d4774971926f1e85437454e09b08c78 |
Hashes for proman_versioning-0.7.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92587034a4afc8d876671c8b3e626712329eddea3a53648d57dd1aa0e85bab6a |
|
MD5 | 8f3dff74cd323a9d288fb877797f4fd1 |
|
BLAKE2b-256 | 0efbe1620cf1b72cb2be12a647795042ff76794015d176f9e10aa9392b8f1cae |